All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Member Functions | List of all members
SurgSim::Math::MlcpSolver Class Referenceabstract

This class provides a solver interface for mixed linear complementarity problems. More...

#include <SurgSim/Math/MlcpSolver.h>

Inheritance diagram for SurgSim::Math::MlcpSolver:
Inheritance graph
[legend]

Public Member Functions

 MlcpSolver ()
 Constructor. More...
 
virtual ~MlcpSolver ()
 
virtual bool solve (const MlcpProblem &problem, MlcpSolution *solution)=0
 Attempts to solve the specified MLCP problem. More...
 

Private Member Functions

 MlcpSolver (const MlcpSolver &)
 Prevent copy construction and assignment. More...
 
MlcpSolveroperator== (const MlcpSolver &)
 

Detailed Description

This class provides a solver interface for mixed linear complementarity problems.

See also
MlcpProblem

Constructor & Destructor Documentation

SurgSim::Math::MlcpSolver::MlcpSolver ( )
inline

Constructor.

virtual SurgSim::Math::MlcpSolver::~MlcpSolver ( )
inlinevirtual
SurgSim::Math::MlcpSolver::MlcpSolver ( const MlcpSolver )
private

Prevent copy construction and assignment.

Member Function Documentation

MlcpSolver& SurgSim::Math::MlcpSolver::operator== ( const MlcpSolver )
private
virtual bool SurgSim::Math::MlcpSolver::solve ( const MlcpProblem problem,
MlcpSolution solution 
)
pure virtual

Attempts to solve the specified MLCP problem.

Parameters
problemthe MLCP problem.
[out]solutionthe solution to the problem, if available.
Returns
true if solved (in which case solution will be set to the solution); false if failed.

Implemented in SurgSim::Math::MlcpGaussSeidelSolver.


The documentation for this class was generated from the following file: