include/opencascade/Expr_Sum.hxx

0001 // Created on: 1991-01-14
0002 // Created by: Arnaud BOUZY
0003 // Copyright (c) 1991-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _Expr_Sum_HeaderFile
0018 #define _Expr_Sum_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Expr_PolyExpression.hxx>
0024 #include <Expr_SequenceOfGeneralExpression.hxx>
0025 #include <Standard_Integer.hxx>
0026 #include <Expr_Array1OfNamedUnknown.hxx>
0027 #include <TColStd_Array1OfReal.hxx>
0028 class Expr_GeneralExpression;
0029 class Expr_NamedUnknown;
0030 class TCollection_AsciiString;
0031
0032
0033 class Expr_Sum;
0034 DEFINE_STANDARD_HANDLE(Expr_Sum, Expr_PolyExpression)
0035
0036
0037 class Expr_Sum : public Expr_PolyExpression
0038 {
0039
0040 public:
0041
0042
0043   //! Creates the sum of all the members of sequence <exps>.
0044   Standard_EXPORT Expr_Sum(const Expr_SequenceOfGeneralExpression& exps);
0045
0046   //! Creates the sum of <exp1> and <exp2>.
0047   Standard_EXPORT Expr_Sum(const Handle(Expr_GeneralExpression)& exp1, const Handle(Expr_GeneralExpression)& exp2);
0048
0049   //! Returns a GeneralExpression after a simplification
0050   //! of the arguments of <me>.
0051   Standard_EXPORT Handle(Expr_GeneralExpression) ShallowSimplified() const Standard_OVERRIDE;
0052
0053   //! Returns a copy of <me> having the same unknowns and functions.
0054   Standard_EXPORT Handle(Expr_GeneralExpression) Copy() const Standard_OVERRIDE;
0055
0056   //! Tests if <me> and <Other> define the same expression.
0057   //! This method does not include any simplification before
0058   //! testing.
0059   Standard_EXPORT Standard_Boolean IsIdentical (const Handle(Expr_GeneralExpression)& Other) const Standard_OVERRIDE;
0060
0061   Standard_EXPORT Standard_Boolean IsLinear() const Standard_OVERRIDE;
0062
0063   //! Returns the derivative on <X> unknown of <me>.
0064   Standard_EXPORT Handle(Expr_GeneralExpression) Derivative (const Handle(Expr_NamedUnknown)& X) const Standard_OVERRIDE;
0065
0066   //! Returns the <N>-th derivative on <X> unknown of <me>.
0067   //! Raises OutOfRange if <N> <= 0
0068   Standard_EXPORT virtual Handle(Expr_GeneralExpression) NDerivative (const Handle(Expr_NamedUnknown)& X, const Standard_Integer N) const Standard_OVERRIDE;
0069
0070   //! Returns the value of <me> (as a Real) by
0071   //! replacement of <vars> by <vals>.
0072   //! Raises NotEvaluable if <me> contains NamedUnknown not
0073   //! in <vars> or NumericError if result cannot be computed.
0074   Standard_EXPORT Standard_Real Evaluate (const Expr_Array1OfNamedUnknown& vars, const TColStd_Array1OfReal& vals) const Standard_OVERRIDE;
0075
0076   //! returns a string representing <me> in a readable way.
0077   Standard_EXPORT TCollection_AsciiString String() const Standard_OVERRIDE;
0078
0079
0080
0081
0082   DEFINE_STANDARD_RTTIEXT(Expr_Sum,Expr_PolyExpression)
0083
0084 protected:
0085
0086
0087
0088
0089 private:
0090
0091
0092
0093
0094 };
0095
0096
0097
0098
0099
0100
0101
0102 #endif // _Expr_Sum_HeaderFile