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