src/math/math_MultipleVarFunction.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
  24 deferred class MultipleVarFunction from math
  25         ---Purpose:
  26         -- Describes the virtual functions associated with a multiple variable function.
  27 uses Vector from math
  28
  29 is
  30
  31     NbVariables(me)
  32         ---Purpose:
  33         -- Returns the number of variables of the function
  34
  35     returns Integer
  36     is deferred;
  37
  38
  39     Value(me: in out; X: Vector; F: out Real)
  40         ---Purpose: Computes the values of the Functions <F> for the
  41         --          variable <X>.
  42         --          returns True if the computation was done successfully,
  43         --      otherwise false.
  44
  45     returns Boolean
  46     is deferred;
  47
  48
  49     GetStateNumber(me: in out)
  50         ---Purpose: return the state of the function corresponding to the latestt
  51         --          call of any methods associated to the function. This
  52         --          function is called by each of the algorithms described
  53         --          later which define the function Integer
  54         --          Algorithm::StateNumber(). The algorithm has the
  55         --          responsibility to call this function when it has found
  56         --          a solution (i.e. a root or a minimum) and has to maintain
  57         --          the association between the solution found and this
  58         --          StateNumber.
  59         --          Byu default, this method returns 0 (which means for the
  60         --          algorithm: no state has been saved). It is the
  61         --          responsibility of the programmer to decide if he needs
  62         --          to save the current state of the function and to return
  63         --          an Integer that allows retrieval of the state.
  64
  65     returns Integer
  66     is virtual;
  67
  68 end MultipleVarFunction;