Files
OCCT/src/math/math_MultipleVarFunction.cdl
bugmster 973c2be1e1 0024428: Implementation of LGPL license
The copying permission statements at the beginning of source files updated to refer to LGPL.
Copyright dates extended till 2014 in advance.
2013-12-17 12:42:41 +04:00

62 lines
2.3 KiB
Plaintext

-- Created on: 1991-05-13
-- Created by: Laurent Painnot
-- Copyright (c) 1991-1999 Matra Datavision
-- Copyright (c) 1999-2014 OPEN CASCADE SAS
--
-- This file is part of Open CASCADE Technology software library.
--
-- This library is free software; you can redistribute it and / or modify it
-- under the terms of the GNU Lesser General Public version 2.1 as published
-- by the Free Software Foundation, with special exception defined in the file
-- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
-- distribution for complete text of the license and disclaimer of any warranty.
--
-- Alternatively, this file may be used under the terms of Open CASCADE
-- commercial license or contractual agreement.
deferred class MultipleVarFunction from math
---Purpose:
-- Describes the virtual functions associated with a multiple variable function.
uses Vector from math
is
NbVariables(me)
---Purpose:
-- Returns the number of variables of the function
returns Integer
is deferred;
Value(me: in out; X: Vector; F: out Real)
---Purpose: Computes the values of the Functions <F> for the
-- variable <X>.
-- returns True if the computation was done successfully,
-- otherwise false.
returns Boolean
is deferred;
GetStateNumber(me: in out)
---Purpose: return the state of the function corresponding to the latestt
-- call of any methods associated to the function. This
-- function is called by each of the algorithms described
-- later which define the function Integer
-- Algorithm::StateNumber(). The algorithm has the
-- responsibility to call this function when it has found
-- a solution (i.e. a root or a minimum) and has to maintain
-- the association between the solution found and this
-- StateNumber.
-- Byu default, this method returns 0 (which means for the
-- algorithm: no state has been saved). It is the
-- responsibility of the programmer to decide if he needs
-- to save the current state of the function and to return
-- an Integer that allows retrieval of the state.
returns Integer
is virtual;
end MultipleVarFunction;