src/Expr/Expr_UnaryFunction.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_UnaryFunction_HeaderFile
  18 #define _Expr_UnaryFunction_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <Expr_UnaryExpression.hxx>
  24 #include <Standard_Boolean.hxx>
  25 #include <Standard_Real.hxx>
  26 #include <Expr_Array1OfNamedUnknown.hxx>
  27 #include <TColStd_Array1OfReal.hxx>
  28 class Expr_GeneralFunction;
  29 class Expr_InvalidFunction;
  30 class Standard_NumericError;
  31 class Expr_NotEvaluable;
  32 class Expr_GeneralExpression;
  33 class Expr_NamedUnknown;
  34 class TCollection_AsciiString;
  35
  36
  37 class Expr_UnaryFunction;
  38 DEFINE_STANDARD_HANDLE(Expr_UnaryFunction, Expr_UnaryExpression)
  39
  40 //! Defines the use of an unary function in an expression
  41 //! with a given argument.
  42 class Expr_UnaryFunction : public Expr_UnaryExpression
  43 {
  44
  45 public:
  46
  47
  48   //! Creates me as <func>(<exp>).
  49   //! Raises exception if <func> is not unary.
  50   Standard_EXPORT Expr_UnaryFunction(const Handle(Expr_GeneralFunction)& func, const Handle(Expr_GeneralExpression)& exp);
  51
  52   //! Returns the function defining <me>.
  53   Standard_EXPORT Handle(Expr_GeneralFunction) Function() const;
  54
  55   //! Returns a GeneralExpression after a simplification
  56   //! of the arguments of <me>.
  57   Standard_EXPORT Handle(Expr_GeneralExpression) ShallowSimplified() const Standard_OVERRIDE;
  58
  59   //! Returns a copy of <me> having the same unknowns and functions.
  60   Standard_EXPORT Handle(Expr_GeneralExpression) Copy() const Standard_OVERRIDE;
  61
  62   //! Tests if <me> and <Other> define the same expression.
  63   //! This method does not include any simplification before
  64   //! testing.
  65   Standard_EXPORT Standard_Boolean IsIdentical (const Handle(Expr_GeneralExpression)& Other) const Standard_OVERRIDE;
  66
  67   Standard_EXPORT Standard_Boolean IsLinear() const Standard_OVERRIDE;
  68
  69   //! returns the derivative on <X> unknown of <me>.
  70   Standard_EXPORT Handle(Expr_GeneralExpression) Derivative (const Handle(Expr_NamedUnknown)& X) const Standard_OVERRIDE;
  71
  72   //! Returns the value of <me> (as a Real) by
  73   //! replacement of <vars> by <vals>.
  74   //! Raises NotEvaluable if <me> contains NamedUnknown not
  75   //! in <vars> or NumericError if result cannot be computed.
  76   Standard_EXPORT Standard_Real Evaluate (const Expr_Array1OfNamedUnknown& vars, const TColStd_Array1OfReal& vals) const Standard_OVERRIDE;
  77
  78   //! returns a string representing <me> in a readable way.
  79   Standard_EXPORT TCollection_AsciiString String() const Standard_OVERRIDE;
  80
  81
  82
  83
  84   DEFINE_STANDARD_RTTIEXT(Expr_UnaryFunction,Expr_UnaryExpression)
  85
  86 protected:
  87
  88
  89
  90
  91 private:
  92
  93
  94   Handle(Expr_GeneralFunction) myFunction;
  95
  96
  97 };
  98
  99
 100
 101
 102
 103
 104
 105 #endif // _Expr_UnaryFunction_HeaderFile