CepsPolynomial.hpp

Go to the documentation of this file.

/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   This file is part of CEPS.
 
   CEPS is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.
 
   CEPS is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.
 
   You should have received a copy of the GNU General Public License
   along with CEPS (see file LICENSE at root of project).
   If not, see <https://www.gnu.org/licenses/>.
 
 
   Copyright 2019-2024 Inria, Universite de Bordeaux
 
   Authors, in alphabetical order:
 
     Pierre-Elliott BECUE, Florian CARO, Yves COUDIERE(*), Andjela DAVIDOVIC, 
     Charlie DOUANLA-LONTSI, Marc FUENTES, Mehdi JUHOOR, Michael LEGUEBE(*), 
     Pauline MIGERDITICHAN, Valentin PANNETIER(*), Nejib ZEMZEMI.
     * : currently active authors
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
#pragma once
 
#include "common/abstract/CepsFunction.hpp"
 
template <CepsUInt _ArgsDim>
class Monomial : public ceps::Function<CepsReal (const CepsArray<CepsReal, _ArgsDim> &)>
{
  public:
 
    using ExponentType = CepsArray<CepsInt, _ArgsDim>;
    using ArgType      = CepsArray<CepsReal, _ArgsDim>;
    using GradientType = CepsArray<CepsReal, _ArgsDim>;
    using FunctionType = ceps::Function<CepsReal (const ArgType &)>;
 
    Monomial (const ExponentType &exponent = {});
 
    Monomial (const Monomial &that);
  
    Monomial &
    operator= (const Monomial &that);
  
    ~Monomial ();
 
    ExponentType
    getExponents() const;
 
    void
    setExponents (const ExponentType &exponent);
  
    CepsReal
    eval (const ArgType &x) override;
  
    GradientType
    gradient (const ArgType &x) const;
 
    CepsBool
    operator== (const Monomial &other) const;
  
    CepsBool
    operator== (const ExponentType &other) const;
  
    Monomial
    operator* (const Monomial &other) const;
  
    Monomial
    operator/ (const Monomial &other) const;
 
  protected:
    ExponentType m_exponent;
 
};
 
 
template <CepsUInt _ArgsDim>
class Polynomial : public ceps::Function<CepsReal (const CepsArray<CepsReal, _ArgsDim> &)>
{
  
  public:
 
    using ExponentType = typename Monomial<_ArgsDim>::ExponentType;
    using ArgType      = typename Monomial<_ArgsDim>::ArgType;
    using GradientType = typename Monomial<_ArgsDim>::GradientType;
    using FunctionType = typename Monomial<_ArgsDim>::FunctionType;
    using MonomialType = Monomial<_ArgsDim>;
 
    Polynomial ();
 
    Polynomial (const Polynomial &that);
  
    Polynomial &
    operator= (const Polynomial &that);
  
    ~Polynomial ();
  
    void
    add (CepsReal coeff, ExponentType exponent);
  
    void
    add (const CepsVector<CepsReal> &coeffs, const CepsVector<ExponentType> &exponents);
  
    void
    add (const Eigen::Matrix<CepsReal, 1, -1> &coeffs, const CepsVector<ExponentType> &exponents);
  
    void
    setCoeff (CepsReal coeff, const ExponentType &exponent);
  
    CepsBool
    contains (const MonomialType &other);
  
    CepsBool
    contains (const ExponentType &other);
  
    CepsReal &
    coeffAt (const ExponentType &other);
  
    CepsReal
    eval (const ArgType &x) override;
  
    GradientType
    gradient (const ArgType &x) const;
  
    CepsUInt
    getNumberOfMonomials () const;
 
    void
    reset ();
  
    void
    pruneZeroCoeffs (CepsReal epsilon = FLOATING_POINT_EPSILON);
 
    Polynomial
    operator* (const Polynomial &b);
 
  protected:
    CepsVector<CepsReal>     m_coeffs;
    CepsVector<MonomialType> m_mono;
};
 
// Template member definitions
#include "common/math/CepsPolynomial.tpp"