b20035f2ec84cee8338b4e8f63c08bd8f6deebaf
[occt.git] / src / math / math_MultipleVarFunctionWithHessian.cdl
1 -- Created on: 1996-02-28
2 -- Created by: Philippe MANGIN
3 -- Copyright (c) 1996-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 MultipleVarFunctionWithHessian from math 
18       inherits MultipleVarFunctionWithGradient  from math
19
20         ---Purpose: 
21
22 uses Matrix from math,
23      Vector from math
24
25 is
26
27     Delete(me:out) is redefined virtual;
28     ---C++: alias "Standard_EXPORT virtual ~math_MultipleVarFunctionWithHessian(){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 
39         --          variable <X>.
40         --          Returns True if the computation was done successfully, 
41         --          False otherwise.
42
43     returns Boolean
44     is deferred;
45     
46     
47     Gradient(me: in out; X: Vector; G: out Vector)
48         ---Purpose:computes the gradient <G> of the functions for the 
49         --         variable <X>.
50         --         Returns True if the computation was done successfully, 
51         --         False otherwise.
52
53     returns Boolean
54     is deferred;
55     
56     
57     Values(me: in out; X: Vector; F: out Real; G: out Vector)
58         ---Purpose: computes the value <F> and the gradient <G> of the 
59         --          functions for the variable <X>.
60         --          Returns True if the computation was done successfully, 
61         --          False otherwise.
62
63     returns Boolean
64     is deferred;
65     
66     Values(me: in out; X: Vector; F: out Real; G: out Vector; H: out Matrix)
67         ---Purpose: computes the value  <F>, the gradient <G> and  the
68         --          hessian   <H> of  the functions  for the  variable <X>.
69         --          Returns  True  if  the computation  was  done
70         --          successfully, False otherwise.
71
72     returns Boolean
73     is deferred;
74
75
76 end MultipleVarFunctionWithHessian;