include/opencascade/Expr_NumericValue.hxx

0001 // Created on: 1991-01-10
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_NumericValue_HeaderFile
0018 #define _Expr_NumericValue_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Expr_GeneralExpression.hxx>
0024 #include <Standard_Integer.hxx>
0025 #include <NCollection_Array1.hxx>
0026 class Expr_NamedUnknown;
0027 class TCollection_AsciiString;
0028
0029 //! This class describes any reel value defined in an
0030 //! expression.
0031 class Expr_NumericValue : public Expr_GeneralExpression
0032 {
0033
0034 public:
0035   Standard_EXPORT Expr_NumericValue(const double val);
0036
0037   Standard_EXPORT double GetValue() const;
0038
0039   Standard_EXPORT void SetValue(const double val);
0040
0041   //! Returns the number of sub-expressions contained
0042   //! in <me> ( >= 0)
0043   Standard_EXPORT int NbSubExpressions() const override;
0044
0045   //! Returns the <I>-th sub-expression of <me>
0046   //! raises OutOfRange if <I> > NbSubExpressions(me)
0047   Standard_EXPORT const occ::handle<Expr_GeneralExpression>& SubExpression(
0048     const int I) const override;
0049
0050   //! Returns a GeneralExpression after replacement of
0051   //! NamedUnknowns by an associated expression and after
0052   //! values computation.
0053   Standard_EXPORT occ::handle<Expr_GeneralExpression> Simplified() const override;
0054
0055   //! Returns a GeneralExpression after a simplification
0056   //! of the arguments of <me>.
0057   Standard_EXPORT occ::handle<Expr_GeneralExpression> ShallowSimplified() const override;
0058
0059   //! Returns a copy of <me> having the same unknowns and functions.
0060   Standard_EXPORT occ::handle<Expr_GeneralExpression> Copy() const override;
0061
0062   //! Tests if <me> contains NamedUnknown.
0063   Standard_EXPORT bool ContainsUnknowns() const override;
0064
0065   //! Tests if <exp> is contained in <me>.
0066   Standard_EXPORT bool Contains(const occ::handle<Expr_GeneralExpression>& exp) const override;
0067
0068   //! Tests if <me> and <Other> define the same expression.
0069   //! This method does not include any simplification before
0070   //! testing.
0071   Standard_EXPORT bool IsIdentical(const occ::handle<Expr_GeneralExpression>& Other) const override;
0072
0073   Standard_EXPORT bool IsLinear() const override;
0074
0075   //! Returns the derivative on <X> unknown of <me>
0076   Standard_EXPORT occ::handle<Expr_GeneralExpression> Derivative(
0077     const occ::handle<Expr_NamedUnknown>& X) const override;
0078
0079   //! Returns the <N>-th derivative on <X> unknown of <me>.
0080   //! Raises OutOfRange if <N> <= 0
0081   Standard_EXPORT occ::handle<Expr_GeneralExpression> NDerivative(
0082     const occ::handle<Expr_NamedUnknown>& X,
0083     const int                             N) const override;
0084
0085   //! Replaces all occurrences of <var> with <with> in <me>
0086   Standard_EXPORT void Replace(const occ::handle<Expr_NamedUnknown>&      var,
0087                                const occ::handle<Expr_GeneralExpression>& with) override;
0088
0089   //! Returns the value of <me> (as a Real) by
0090   //! replacement of <vars> by <vals>.
0091   Standard_EXPORT double Evaluate(const NCollection_Array1<occ::handle<Expr_NamedUnknown>>& vars,
0092                                   const NCollection_Array1<double>& vals) const override;
0093
0094   //! returns a string representing <me> in a readable way.
0095   Standard_EXPORT TCollection_AsciiString String() const override;
0096
0097   DEFINE_STANDARD_RTTIEXT(Expr_NumericValue, Expr_GeneralExpression)
0098
0099 private:
0100   double myValue;
0101 };
0102
0103 #endif // _Expr_NumericValue_HeaderFile