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:

## 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...
MlcpSolver & | operator== (const MlcpSolver &)

## Detailed Description

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

See also
  MlcpProblem

## Constructor & Destructor Documentation

## MlcpSolver() [1/2]

SurgSim::Math::MlcpSolver::MlcpSolver | ( |  | ) |

inline

Constructor.

## ~MlcpSolver()

virtual SurgSim::Math::MlcpSolver::~MlcpSolver | ( |  | ) |

inline virtual

## MlcpSolver() [2/2]

SurgSim::Math::MlcpSolver::MlcpSolver | ( | const MlcpSolver & |  | ) |

private

Prevent copy construction and assignment.

## Member Function Documentation

## operator==()

MlcpSolver& SurgSim::Math::MlcpSolver::operator== | ( | const MlcpSolver & |  | ) |

private

## solve()

virtual bool SurgSim::Math::MlcpSolver::solve | ( | const MlcpProblem & | problem,
|  | MlcpSolution * | solution
| ) |  |

pure virtual

Attempts to solve the specified MLCP problem.

Parameters

  | problem | the MLCP problem.
  [out] | solution | the 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:

- SurgSim/Math/MlcpSolver.h