include/opencascade/Expr_UnaryFunction.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_UnaryFunction_HeaderFile
0018 #define _Expr_UnaryFunction_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Expr_UnaryExpression.hxx>
0024 #include <NCollection_Array1.hxx>
0025 class Expr_GeneralFunction;
0026 class Expr_GeneralExpression;
0027 class Expr_NamedUnknown;
0028 class TCollection_AsciiString;
0029
0030 //! Defines the use of an unary function in an expression
0031 //! with a given argument.
0032 class Expr_UnaryFunction : public Expr_UnaryExpression
0033 {
0034
0035 public:
0036   //! Creates me as <func>(<exp>).
0037   //! Raises exception if <func> is not unary.
0038   Standard_EXPORT Expr_UnaryFunction(const occ::handle<Expr_GeneralFunction>&   func,
0039                                      const occ::handle<Expr_GeneralExpression>& exp);
0040
0041   //! Returns the function defining <me>.
0042   Standard_EXPORT occ::handle<Expr_GeneralFunction> Function() const;
0043
0044   //! Returns a GeneralExpression after a simplification
0045   //! of the arguments of <me>.
0046   Standard_EXPORT occ::handle<Expr_GeneralExpression> ShallowSimplified() const override;
0047
0048   //! Returns a copy of <me> having the same unknowns and functions.
0049   Standard_EXPORT occ::handle<Expr_GeneralExpression> Copy() const override;
0050
0051   //! Tests if <me> and <Other> define the same expression.
0052   //! This method does not include any simplification before
0053   //! testing.
0054   Standard_EXPORT bool IsIdentical(const occ::handle<Expr_GeneralExpression>& Other) const override;
0055
0056   Standard_EXPORT bool IsLinear() const override;
0057
0058   //! returns the derivative on <X> unknown of <me>.
0059   Standard_EXPORT occ::handle<Expr_GeneralExpression> Derivative(
0060     const occ::handle<Expr_NamedUnknown>& X) const override;
0061
0062   //! Returns the value of <me> (as a Real) by
0063   //! replacement of <vars> by <vals>.
0064   //! Raises NotEvaluable if <me> contains NamedUnknown not
0065   //! in <vars> or NumericError if result cannot be computed.
0066   Standard_EXPORT double Evaluate(const NCollection_Array1<occ::handle<Expr_NamedUnknown>>& vars,
0067                                   const NCollection_Array1<double>& vals) const override;
0068
0069   //! returns a string representing <me> in a readable way.
0070   Standard_EXPORT TCollection_AsciiString String() const override;
0071
0072   DEFINE_STANDARD_RTTIEXT(Expr_UnaryFunction, Expr_UnaryExpression)
0073
0074 private:
0075   occ::handle<Expr_GeneralFunction> myFunction;
0076 };
0077
0078 #endif // _Expr_UnaryFunction_HeaderFile