PRMParameter.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2026 by                                             *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *                                                                          *
 *   The aGrUM/pyAgrum library is free software; you can redistribute it    *
 *   and/or modify it under the terms of either :                           *
 *                                                                          *
 *    - the GNU Lesser General Public License as published by               *
 *      the Free Software Foundation, either version 3 of the License,      *
 *      or (at your option) any later version,                              *
 *    - the MIT license (MIT),                                              *
 *    - or both in dual license, as here.                                   *
 *                                                                          *
 *   (see https://agrum.gitlab.io/articles/dual-licenses-lgplv3mit.html)    *
 *                                                                          *
 *   This aGrUM/pyAgrum library is distributed in the hope that it will be  *
 *   useful, but WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,          *
 *   INCLUDING BUT NOT LIMITED TO THE WARRANTIES MERCHANTABILITY or FITNESS *
 *   FOR A PARTICULAR PURPOSE  AND NONINFRINGEMENT. IN NO EVENT SHALL THE   *
 *   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
 *   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,        *
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR  *
 *   OTHER DEALINGS IN THE SOFTWARE.                                        *
 *                                                                          *
 *   See LICENCES for more details.                                         *
 *                                                                          *
 *   SPDX-FileCopyrightText: Copyright 2005-2026                            *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *   SPDX-License-Identifier: LGPL-3.0-or-later OR MIT                      *
 *                                                                          *
 *   Contact  : info_at_agrum_dot_org                                       *
 *   homepage : http://agrum.gitlab.io                                      *
 *   gitlab   : https://gitlab.com/agrumery/agrum                           *
 *                                                                          *
 ****************************************************************************/
 

 
#ifndef GUM_PARAMETER_H
#define GUM_PARAMETER_H
 
 
#include <agrum/PRM/elements/PRMAttribute.h>
#include <agrum/PRM/elements/PRMType.h>
 
namespace gum {
  namespace prm {

    template < GUM_Numeric GUM_SCALAR >
    class PRMParameter: public PRMClassElement< GUM_SCALAR > {
      public:
      enum ParameterType { INT, REAL };
 
      // ========================================================================
      // ========================================================================

      PRMParameter(std::string_view name, ParameterType type, GUM_SCALAR value);

      ~PRMParameter() override;

      // ========================================================================
      // ========================================================================

      typename PRMClassElement< GUM_SCALAR >::ClassElementType elt_type() const override;
 
      GUM_SCALAR value() const;
 
      void value(GUM_SCALAR value);
 
      ParameterType valueType() const;

      PRMType& type() override;

      const PRMType& type() const override;

      virtual Tensor< GUM_SCALAR >& cpf();

      const Tensor< GUM_SCALAR >& cpf() const override;

      void addParent(const gum::prm::PRMClassElement< GUM_SCALAR >&) override;

      void addChild(const gum::prm::PRMClassElement< GUM_SCALAR >&) override;

      PRMAttribute< GUM_SCALAR >* getCastDescendant() const override;

 
      protected:
      PRMParameter(const PRMParameter< GUM_SCALAR >& source);

      PRMParameter< GUM_SCALAR >& operator=(const PRMParameter< GUM_SCALAR >& from);
 
      private:
      // ========================================================================
      // ========================================================================
 
      ParameterType _type_;
 
      GUM_SCALAR _value_;

    };
 
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
    extern template class PRMParameter< double >;
#endif
 
 
  } /* namespace prm */
}   // namespace gum
 
#include <agrum/PRM/elements/PRMParameter_tpl.h>
 
#endif /* GUM_PARAMETER_H */