src/math/math_FunctionSet.cdl

   1 -- Created on: 1991-05-13
   2 -- Created by: Laurent PAINNOT
   3 -- Copyright (c) 1991-1999 Matra Datavision
   4 -- Copyright (c) 1999-2012 OPEN CASCADE SAS
   5 --
   6 -- The content of this file is subject to the Open CASCADE Technology Public
   7 -- License Version 6.5 (the "License"). You may not use the content of this file
   8 -- except in compliance with the License. Please obtain a copy of the License
   9 -- at http://www.opencascade.org and read it completely before using this file.
  10 --
  11 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
  12 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
  13 --
  14 -- The Original Code and all software distributed under the License is
  15 -- distributed on an "AS IS" basis, without warranty of any kind, and the
  16 -- Initial Developer hereby disclaims all such warranties, including without
  17 -- limitation, any warranties of merchantability, fitness for a particular
  18 -- purpose or non-infringement. Please see the License for the specific terms
  19 -- and conditions governing the rights and limitations under the License.
  20
  21
  22
  23 deferred class FunctionSet from math
  24         ---Purpose:
  25         -- This abstract class describes the virtual functions associated to
  26         -- a set on N Functions of M independant variables.
  27
  28 uses Vector from math
  29
  30 is
  31
  32     Delete(me:out) is virtual;
  33         ---C++: alias "Standard_EXPORT virtual ~math_FunctionSet(){Delete();}"
  34
  35     NbVariables(me)
  36         ---Purpose: Returns the number of variables of the function.
  37
  38     returns Integer
  39     is deferred;
  40
  41
  42     NbEquations(me)
  43         ---Purpose: Returns the number of equations of the function.
  44
  45     returns Integer
  46     is deferred;
  47
  48
  49     Value(me: in out; X: Vector; F: out Vector)
  50         ---Purpose: Computes the values <F> of the functions for the
  51         --          variable <X>.
  52         --          returns True if the computation was done successfully,
  53         --          False otherwise.
  54
  55     returns Boolean
  56     is deferred;
  57
  58
  59     GetStateNumber(me: in out)
  60         ---Purpose: Returns the state of the function corresponding to the
  61         --          latestcall of any methods associated with the function.
  62         --          This function is called by each of the algorithms
  63         --          described later which define the function Integer
  64         --          Algorithm::StateNumber(). The algorithm has the
  65         --          responsibility to call this function when it has found
  66         --          a solution (i.e. a root or a minimum) and has to maintain
  67         --          the association between the solution found and this
  68         --          StateNumber.
  69         --          Byu default, this method returns 0 (which means for the
  70         --          algorithm: no state has been saved). It is the
  71         --          responsibility of the programmer to decide if he needs
  72         --          to save the current state of the function and to return
  73         --          an Integer that allows retrieval of the state.
  74
  75     returns Integer
  76     is virtual;
  77
  78 end FunctionSet;
  79
  80