include/opencascade/Expr_NamedUnknown.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_NamedUnknown_HeaderFile
0018 #define _Expr_NamedUnknown_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Expr_NamedExpression.hxx>
0024 #include <Standard_Integer.hxx>
0025 #include <NCollection_Array1.hxx>
0026 class Expr_GeneralExpression;
0027 class TCollection_AsciiString;
0028
0029 //! This class describes any variable of an expression.
0030 //! Assignment is treated directly in this class.
0031 class Expr_NamedUnknown : public Expr_NamedExpression
0032 {
0033
0034 public:
0035   Standard_EXPORT Expr_NamedUnknown(const TCollection_AsciiString& name);
0036
0037   //! Tests if an expression is assigned to <me>.
0038   bool IsAssigned() const;
0039
0040   //! If exists, returns the assigned expression.
0041   //! An exception is raised if the expression does not exist.
0042   Standard_EXPORT const occ::handle<Expr_GeneralExpression>& AssignedExpression() const;
0043
0044   //! Assigns <me> to <exp> expression.
0045   //! Raises exception if <exp> refers to <me>.
0046   Standard_EXPORT void Assign(const occ::handle<Expr_GeneralExpression>& exp);
0047
0048   //! Suppresses the assigned expression
0049   void Deassign();
0050
0051   //! Returns the number of sub-expressions contained
0052   //! in <me> ( >= 0)
0053   Standard_EXPORT int NbSubExpressions() const override;
0054
0055   //! Returns the <I>-th sub-expression of <me>
0056   //! raises OutOfRange if <I> > NbSubExpressions(me)
0057   Standard_EXPORT const occ::handle<Expr_GeneralExpression>& SubExpression(
0058     const int I) const override;
0059
0060   //! Returns a GeneralExpression after replacement of
0061   //! NamedUnknowns by an associated expression and after
0062   //! values computation.
0063   Standard_EXPORT occ::handle<Expr_GeneralExpression> Simplified() const override;
0064
0065   //! Returns a GeneralExpression after a simplification
0066   //! of the arguments of <me>.
0067   Standard_EXPORT occ::handle<Expr_GeneralExpression> ShallowSimplified() const override;
0068
0069   //! Returns a copy of <me> having the same unknowns and functions.
0070   Standard_EXPORT occ::handle<Expr_GeneralExpression> Copy() const override;
0071
0072   //! Tests if <me> contains NamedUnknown.
0073   Standard_EXPORT bool ContainsUnknowns() const override;
0074
0075   //! Tests if <exp> is contained in <me>.
0076   Standard_EXPORT bool Contains(const occ::handle<Expr_GeneralExpression>& exp) const override;
0077
0078   Standard_EXPORT bool IsLinear() const override;
0079
0080   //! Returns the derivative on <X> unknown of <me>
0081   Standard_EXPORT occ::handle<Expr_GeneralExpression> Derivative(
0082     const occ::handle<Expr_NamedUnknown>& X) const override;
0083
0084   //! Replaces all occurrences of <var> with <with> in <me>
0085   //! Raises InvalidOperand if <with> contains <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   //! Raises NotEvaluable if <me> contains NamedUnknown not
0092   //! in <vars> or NumericError if result cannot be computed.
0093   Standard_EXPORT double Evaluate(const NCollection_Array1<occ::handle<Expr_NamedUnknown>>& vars,
0094                                   const NCollection_Array1<double>& vals) const override;
0095
0096   DEFINE_STANDARD_RTTIEXT(Expr_NamedUnknown, Expr_NamedExpression)
0097
0098 private:
0099   occ::handle<Expr_GeneralExpression> myExpression;
0100 };
0101
0102 #include <Expr_NamedUnknown.lxx>
0103 class Expr_NamedUnknown;
0104
0105 #endif // _Expr_NamedUnknown_HeaderFile