src/math/math_MultipleVarFunctionWithGradient.cdl

   1 -- Created on: 1991-05-13
   2 -- Created by: Laurent PAINNOT
   3 -- Copyright (c) 1991-1999 Matra Datavision
   4 -- Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 --
   6 -- This file is part of Open CASCADE Technology software library.
   7 --
   8 -- This library is free software; you can redistribute it and/or modify it under
   9 -- the terms of the GNU Lesser General Public License version 2.1 as published
  10 -- by the Free Software Foundation, with special exception defined in the file
  11 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 -- distribution for complete text of the license and disclaimer of any warranty.
  13 --
  14 -- Alternatively, this file may be used under the terms of Open CASCADE
  15 -- commercial license or contractual agreement.
  16
  17 deferred class MultipleVarFunctionWithGradient from math
  18
  19 inherits MultipleVarFunction
  20 ---Purpose:
  21 -- The abstract class MultipleVarFunctionWithGradient
  22 -- describes the virtual functions associated with a multiple variable function.
  23 uses Vector from math
  24
  25 is
  26
  27     Delete(me:out) is virtual;
  28     ---C++: alias "Standard_EXPORT virtual ~math_MultipleVarFunctionWithGradient(){Delete();}"
  29
  30     NbVariables(me)
  31         ---Purpose: Returns the number of variables of the function.
  32
  33     returns Integer
  34     is deferred;
  35
  36
  37     Value(me: in out; X: Vector; F: out Real)
  38         ---Purpose: Computes the values of the Functions <F> for the   variable <X>.
  39         --          Returns True if the computation was done successfully,
  40         --          False otherwise.
  41
  42     returns Boolean
  43     is deferred;
  44
  45
  46     Gradient(me: in out; X: Vector; G: out Vector)
  47         ---Purpose: Computes the gradient <G> of the functions for the   variable <X>.
  48         --         Returns True if the computation was done successfully,
  49         --         False otherwise.
  50
  51     returns Boolean
  52     is deferred;
  53
  54
  55     Values(me: in out; X: Vector; F: out Real; G: out Vector)
  56         ---Purpose: computes the value <F> and the gradient <G> of the
  57         --          functions for the variable <X>.
  58         --          Returns True if the computation was done successfully,
  59         --          False otherwise.
  60
  61     returns Boolean
  62     is deferred;
  63
  64 end MultipleVarFunctionWithGradient;