norm.hpp

/*
 *    This file is part of CasADi.
 *
 *    CasADi -- A symbolic framework for dynamic optimization.
 *    Copyright (C) 2010-2023 Joel Andersson, Joris Gillis, Moritz Diehl,
 *                            KU Leuven. All rights reserved.
 *    Copyright (C) 2011-2014 Greg Horn
 *
 *    CasADi is free software; you can redistribute it and/or
 *    modify it under the terms of 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.
 *
 *    CasADi 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
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with CasADi; if not, write to the Free Software
 *    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */
 
 
#ifndef CASADI_NORM_HPP
#define CASADI_NORM_HPP
 
#include "mx_node.hpp"
 
namespace casadi {
 
  class CASADI_EXPORT Norm : public MXNode {
  public:
 
    explicit Norm(const MX& x);
 
    ~Norm() override {}
 
  protected:
    explicit Norm(DeserializingStream& s) : MXNode(s) {}
  };
 
  class CASADI_EXPORT NormF : public Norm {
  public:
 
    explicit NormF(const MX& x) : Norm(x) {}
 
    ~NormF() override {}
 
    template<typename T>
    int eval_gen(const T** arg, T** res, casadi_int* iw, T* w) const;
 
    int eval(const double** arg, double** res, casadi_int* iw, double* w) const override;
 
    int eval_sx(const SXElem** arg, SXElem** res, casadi_int* iw, SXElem* w) const override;
 
    void eval_mx(const std::vector<MX>& arg, std::vector<MX>& res,
        const std::vector<bool>& unique={}) const override;
 
    void ad_forward(const std::vector<std::vector<MX> >& fseed,
                         std::vector<std::vector<MX> >& fsens) const override;
 
    void ad_reverse(const std::vector<std::vector<MX> >& aseed,
                         std::vector<std::vector<MX> >& asens) const override;
 
    void generate(CodeGenerator& g,
                  const std::vector<casadi_int>& arg,
                  const std::vector<casadi_int>& res,
                  const std::vector<bool>& arg_is_ref,
                  std::vector<bool>& res_is_ref) const override;
 
    std::string disp(const std::vector<std::string>& arg) const override;
 
    casadi_int op() const override { return OP_NORMF;}
 
    static MXNode* deserialize(DeserializingStream& s) { return new NormF(s); }
 
  protected:
    explicit NormF(DeserializingStream& s) : Norm(s) {}
  };
 
  class CASADI_EXPORT Norm2 : public Norm {
  public:
 
    explicit Norm2(const MX& x): Norm(x) {}
 
    ~Norm2() override {}
 
    void eval_mx(const std::vector<MX>& arg, std::vector<MX>& res,
        const std::vector<bool>& unique={}) const override;
 
    std::string disp(const std::vector<std::string>& arg) const override;
 
    casadi_int op() const override { return OP_NORM2;}
 
    static MXNode* deserialize(DeserializingStream& s) { return new Norm2(s); }
 
  protected:
    explicit Norm2(DeserializingStream& s) : Norm(s) {}
  };
 
  class CASADI_EXPORT Norm1 : public Norm {
  public:
 
    explicit Norm1(const MX& x) : Norm(x) {}
 
    ~Norm1() override {}
 
    void ad_forward(const std::vector<std::vector<MX> >& fseed,
                         std::vector<std::vector<MX> >& fsens) const override;
 
    void ad_reverse(const std::vector<std::vector<MX> >& aseed,
                         std::vector<std::vector<MX> >& asens) const override;
 
    template<typename T>
    int eval_gen(const T** arg, T** res, casadi_int* iw, T* w) const;
 
    int eval(const double** arg, double** res, casadi_int* iw, double* w) const override;
 
    int eval_sx(const SXElem** arg, SXElem** res, casadi_int* iw, SXElem* w) const override;
 
    void eval_mx(const std::vector<MX>& arg, std::vector<MX>& res,
        const std::vector<bool>& unique={}) const override;
 
    void generate(CodeGenerator& g,
                  const std::vector<casadi_int>& arg,
                  const std::vector<casadi_int>& res,
                  const std::vector<bool>& arg_is_ref,
                  std::vector<bool>& res_is_ref) const override;
 
    std::string disp(const std::vector<std::string>& arg) const override;
 
    casadi_int op() const override { return OP_NORM1;}
 
    static MXNode* deserialize(DeserializingStream& s) { return new Norm1(s); }
 
  protected:
    explicit Norm1(DeserializingStream& s) : Norm(s) {}
  };
 
  class CASADI_EXPORT NormInf : public Norm {
  public:
 
    explicit NormInf(const MX& x) : Norm(x) {}
 
    ~NormInf() override {}
 
    void ad_forward(const std::vector<std::vector<MX> >& fseed,
                         std::vector<std::vector<MX> >& fsens) const override;
 
    void ad_reverse(const std::vector<std::vector<MX> >& aseed,
                         std::vector<std::vector<MX> >& asens) const override;
 
    template<typename T>
    int eval_gen(const T** arg, T** res, casadi_int* iw, T* w) const;
 
    int eval(const double** arg, double** res, casadi_int* iw, double* w) const override;
 
    int eval_sx(const SXElem** arg, SXElem** res, casadi_int* iw, SXElem* w) const override;
 
    void eval_mx(const std::vector<MX>& arg, std::vector<MX>& res,
        const std::vector<bool>& unique={}) const override;
 
    void generate(CodeGenerator& g,
                  const std::vector<casadi_int>& arg,
                  const std::vector<casadi_int>& res,
                  const std::vector<bool>& arg_is_ref,
                  std::vector<bool>& res_is_ref) const override;
 
    std::string disp(const std::vector<std::string>& arg) const override;
 
    casadi_int op() const override { return OP_NORMINF;}
 
    static MXNode* deserialize(DeserializingStream& s) { return new NormInf(s); }
 
  protected:
    explicit NormInf(DeserializingStream& s) : Norm(s) {}
  };
 
} // namespace casadi
 
 
#endif // CASADI_NORM_HPP