labelizedVariable.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_LABELIZED_DISCRETE_VARIABLE_H
#define GUM_LABELIZED_DISCRETE_VARIABLE_H
 
#include <iostream>
#include <sstream>
#include <string>
 
#include <agrum/agrum.h>
 
#include <agrum/base/core/sequence.h>
#include <agrum/base/variables/discreteVariable.h>
 
namespace gum {
  /* =========================================================================*/
  /* =========================================================================*/
  /* ===                        GUM_LABELIZED_VARIABLE === */
  /* =========================================================================*/
  /* =========================================================================*/
  /* =========================================================================*/
 
  class LabelizedVariable final: public DiscreteVariable {
    public:
    // ############################################################################
    // ############################################################################

 
    LabelizedVariable(std::string_view aName, std::string_view aDesc = "", const Size nbrLabel = 2);

 
    LabelizedVariable(std::string_view                  aName,
                      std::string_view                  aDesc,
                      const std::vector< std::string >& labels);


 
    LabelizedVariable(const LabelizedVariable& aLDRV);

 
    ~LabelizedVariable() final;

    [[nodiscard]] LabelizedVariable* clone() const final;

 
    // ############################################################################
    // ############################################################################


    LabelizedVariable& operator=(const LabelizedVariable& aLDRV);
 


    Idx index(std::string_view label) const final;

 
    // ############################################################################
    // ############################################################################

    bool isLabel(std::string_view aLabel) const;


    LabelizedVariable& addLabel(std::string_view aLabel);


    void changeLabel(Idx pos, std::string_view aLabel) const;

    void eraseLabels();


    std::string label(Idx i) const final;

    Idx posLabel(std::string_view label) const;

    double numerical(Idx index) const final;

    Idx closestIndex(double val) const final;

    Size domainSize() const final;

    VarType varType() const final;

    std::string domain() const final;

    std::string stype() const final;
 
    // returns the variable in fast syntax
    std::string toFast() const final;

 
 
    private:

    bool _checkSameDomain_(const Variable& aRV) const final;
 
    protected:
    LabelizedVariable();

 
    void copy_(const LabelizedVariable& aLDRV);
 
    private:
    mutable Sequence< std::string > _labels_;
  };
 
} /* namespace gum */
 
/* ==============================================================================
 */
/* ==============================================================================
 */
/* ===                    LabelizedVariable IMPLEMENTATION === */
/* ==============================================================================
 */
/* ==============================================================================
 */
#ifndef GUM_NO_INLINE
#  include <agrum/base/variables/labelizedVariable_inl.h>
#endif /* GUM_NO_INLINE */
 
#endif /* GUM_LABELIZED_DISCRETE_VARIABLE_H */