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