src/Expr/Expr_Sum.hxx

   1 // Created on: 1991-01-14
   2 // Created by: Arnaud BOUZY
   3 // Copyright (c) 1991-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _Expr_Sum_HeaderFile
  18 #define _Expr_Sum_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <Expr_PolyExpression.hxx>
  24 #include <Expr_SequenceOfGeneralExpression.hxx>
  25 #include <Standard_Boolean.hxx>
  26 #include <Standard_Integer.hxx>
  27 #include <Standard_Real.hxx>
  28 #include <Expr_Array1OfNamedUnknown.hxx>
  29 #include <TColStd_Array1OfReal.hxx>
  30 class Standard_OutOfRange;
  31 class Standard_NumericError;
  32 class Expr_NotEvaluable;
  33 class Expr_GeneralExpression;
  34 class Expr_NamedUnknown;
  35 class TCollection_AsciiString;
  36
  37
  38 class Expr_Sum;
  39 DEFINE_STANDARD_HANDLE(Expr_Sum, Expr_PolyExpression)
  40
  41
  42 class Expr_Sum : public Expr_PolyExpression
  43 {
  44
  45 public:
  46
  47
  48   //! Creates the sum of all the members of sequence <exps>.
  49   Standard_EXPORT Expr_Sum(const Expr_SequenceOfGeneralExpression& exps);
  50
  51   //! Creates the sum of <exp1> and <exp2>.
  52   Standard_EXPORT Expr_Sum(const Handle(Expr_GeneralExpression)& exp1, const Handle(Expr_GeneralExpression)& exp2);
  53
  54   //! Returns a GeneralExpression after a simplification
  55   //! of the arguments of <me>.
  56   Standard_EXPORT Handle(Expr_GeneralExpression) ShallowSimplified() const Standard_OVERRIDE;
  57
  58   //! Returns a copy of <me> having the same unknowns and functions.
  59   Standard_EXPORT Handle(Expr_GeneralExpression) Copy() const Standard_OVERRIDE;
  60
  61   //! Tests if <me> and <Other> define the same expression.
  62   //! This method does not include any simplification before
  63   //! testing.
  64   Standard_EXPORT Standard_Boolean IsIdentical (const Handle(Expr_GeneralExpression)& Other) const Standard_OVERRIDE;
  65
  66   Standard_EXPORT Standard_Boolean IsLinear() const Standard_OVERRIDE;
  67
  68   //! Returns the derivative on <X> unknown of <me>.
  69   Standard_EXPORT Handle(Expr_GeneralExpression) Derivative (const Handle(Expr_NamedUnknown)& X) const Standard_OVERRIDE;
  70
  71   //! Returns the <N>-th derivative on <X> unknown of <me>.
  72   //! Raises OutOfRange if <N> <= 0
  73   Standard_EXPORT virtual Handle(Expr_GeneralExpression) NDerivative (const Handle(Expr_NamedUnknown)& X, const Standard_Integer N) const Standard_OVERRIDE;
  74
  75   //! Returns the value of <me> (as a Real) by
  76   //! replacement of <vars> by <vals>.
  77   //! Raises NotEvaluable if <me> contains NamedUnknown not
  78   //! in <vars> or NumericError if result cannot be computed.
  79   Standard_EXPORT Standard_Real Evaluate (const Expr_Array1OfNamedUnknown& vars, const TColStd_Array1OfReal& vals) const Standard_OVERRIDE;
  80
  81   //! returns a string representing <me> in a readable way.
  82   Standard_EXPORT TCollection_AsciiString String() const Standard_OVERRIDE;
  83
  84
  85
  86
  87   DEFINE_STANDARD_RTTIEXT(Expr_Sum,Expr_PolyExpression)
  88
  89 protected:
  90
  91
  92
  93
  94 private:
  95
  96
  97
  98
  99 };
 100
 101
 102
 103
 104
 105
 106
 107 #endif // _Expr_Sum_HeaderFile