Drake
Public Member Functions | Static Public Member Functions | List of all members
LinearSystemSolver Class Reference

#include <drake/solvers/linear_system_solver.h>

Public Member Functions

 LinearSystemSolver ()=default
 
 ~LinearSystemSolver () override=default
 
bool available () const override
 Returns true iff this solver was enabled at compile-time. More...
 
SolutionResult Solve (MathematicalProgram &prog) const override
 Find the least-square solution to the linear system A * x = b. More...
 
void Solve (const MathematicalProgram &prog, const optional< Eigen::VectorXd > &initial_guess, const optional< SolverOptions > &solver_options, MathematicalProgramResult *result) const override
 Solves an optimization program with optional initial guess and solver options. More...
 
SolverId solver_id () const override
 Returns the identifier of this solver. More...
 
bool AreProgramAttributesSatisfied (const MathematicalProgram &prog) const override
 Returns true if the program attributes are satisfied by the solver's capability. More...
 
Does not allow copy, move, or assignment
 LinearSystemSolver (const LinearSystemSolver &)=delete
 
LinearSystemSolver & operator= (const LinearSystemSolver &)=delete
 
 LinearSystemSolver (LinearSystemSolver &&)=delete
 
LinearSystemSolver & operator= (LinearSystemSolver &&)=delete
 
- Public Member Functions inherited from MathematicalProgramSolverInterface
 MathematicalProgramSolverInterface ()=default
 
virtual ~MathematicalProgramSolverInterface ()=default
 
 MathematicalProgramSolverInterface (const MathematicalProgramSolverInterface &)=delete
 
MathematicalProgramSolverInterface & operator= (const MathematicalProgramSolverInterface &)=delete
 
 MathematicalProgramSolverInterface (MathematicalProgramSolverInterface &&)=delete
 
MathematicalProgramSolverInterface & operator= (MathematicalProgramSolverInterface &&)=delete
 

Static Public Member Functions

static bool is_available ()
 
static SolverId id ()
 
static bool ProgramAttributesSatisfied (const MathematicalProgram &prog)
 

Constructor & Destructor Documentation

◆ LinearSystemSolver() [1/3]

LinearSystemSolver ( const LinearSystemSolver &  )
delete

◆ LinearSystemSolver() [2/3]

LinearSystemSolver ( LinearSystemSolver &&  )
delete

◆ LinearSystemSolver() [3/3]

LinearSystemSolver ( )
default

◆ ~LinearSystemSolver()

~LinearSystemSolver ( )
overridedefault

Member Function Documentation

◆ AreProgramAttributesSatisfied()

bool AreProgramAttributesSatisfied ( const MathematicalProgram &  prog) const
overridevirtual

Returns true if the program attributes are satisfied by the solver's capability.

Implements MathematicalProgramSolverInterface.

◆ available()

bool available ( ) const
inlineoverridevirtual

Returns true iff this solver was enabled at compile-time.

Implements MathematicalProgramSolverInterface.

◆ id()

SolverId id ( )
static
Returns
same as MathematicalProgramSolverInterface::solver_id()

◆ is_available()

bool is_available ( )
static

◆ operator=() [1/2]

LinearSystemSolver& operator= ( LinearSystemSolver &&  )
delete

◆ operator=() [2/2]

LinearSystemSolver& operator= ( const LinearSystemSolver &  )
delete

◆ ProgramAttributesSatisfied()

bool ProgramAttributesSatisfied ( const MathematicalProgram &  prog)
static

◆ Solve() [1/2]

SolutionResult Solve ( MathematicalProgram &  prog) const
overridevirtual

Find the least-square solution to the linear system A * x = b.

Implements MathematicalProgramSolverInterface.

◆ Solve() [2/2]

void Solve ( const MathematicalProgram &  prog,
const optional< Eigen::VectorXd > &  initial_guess,
const optional< SolverOptions > &  solver_options,
MathematicalProgramResult *  result 
) const
overridevirtual

Solves an optimization program with optional initial guess and solver options.

Note that these initial guess and solver options are not written to prog. If the prog has set an option for a solver, and solver_options contains a different value for the same option on the same solver, then solver_options takes priority.

Implements MathematicalProgramSolverInterface.

◆ solver_id()

SolverId solver_id ( ) const
overridevirtual

Returns the identifier of this solver.

Implements MathematicalProgramSolverInterface.

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