discretizedVariable.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2025 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-2025                            *
 *       - 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_DISCRETIZED_VARIABLE_H
#define GUM_DISCRETIZED_VARIABLE_H
 
#include <vector>
 
#include <agrum/agrum.h>
 
#include <agrum/base/variables/IDiscretizedVariable.h>
 
namespace gum {
  template < typename T_TICKS >
  class DiscretizedVariable final: public IDiscretizedVariable {
    private:
    std::vector< T_TICKS > _ticks_;   // Array from 0 to domainSize-2
 
    protected:
    void copy_(const DiscretizedVariable< T_TICKS >& aDRV);

    Idx pos_(const T_TICKS& target) const;
 
    public:

    DiscretizedVariable(const std::string& aName, const std::string& aDesc);

    DiscretizedVariable(const std::string&            aName,
                        const std::string&            aDesc,
                        const std::vector< T_TICKS >& ticks,
                        bool                          is_empirical = false);

    DiscretizedVariable(const DiscretizedVariable< T_TICKS >& aDRV);

    ~DiscretizedVariable() override final;


    DiscretizedVariable< T_TICKS >* clone() const override;

    VarType varType() const override;

    DiscretizedVariable< T_TICKS >& operator=(const DiscretizedVariable< T_TICKS >& aDRV);

    bool isTick(const T_TICKS& aTick) const;

    DiscretizedVariable& addTick(const T_TICKS& aTick);

    void eraseTicks();

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

    double numerical(Idx indice) const override;

    double draw(Idx indice) const override;

    Idx index(const std::string& label) const override;
    Idx index(const T_TICKS tick) const;

    Size domainSize() const override;
 
    std::string domain() const override;

    std::string stype() const override final { return "Discretized"; };

    const T_TICKS& tick(Idx i) const;

    const std::vector< T_TICKS >& ticks() const;

    std::vector< double > ticksAsDoubles() const override;

    Idx closestIndex(double val) const override;
 
    // returns the variable in fast syntax
    std::string toFast() const override;
 
    private:

    bool _checkSameDomain_(const Variable& aRV) const override;
  };
 
} /* namespace gum */

#include <agrum/base/variables/discretizedVariable_tpl.h>
 
#endif /* GUM_DISCRETIZED_VARIABLE_H */