Drake
LinearSystemSolver Class Referencefinal

Detailed Description

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

#include <drake/solvers/linear_system_solver.h>

Public Member Functions

 LinearSystemSolver ()
 
 ~LinearSystemSolver () final
 
MathematicalProgramResult Solve (const MathematicalProgram &prog, const std::optional< Eigen::VectorXd > &initial_guess=std::nullopt, const std::optional< SolverOptions > &solver_options=std::nullopt) const
 Like SolverInterface::Solve(), but the result is a return value instead of an output argument. More...
 
void Solve (const MathematicalProgram &, const std::optional< Eigen::VectorXd > &, const std::optional< SolverOptions > &, MathematicalProgramResult *) const override
 
Does not allow copy, move, or assignment
 LinearSystemSolver (const LinearSystemSolver &)=delete
 
LinearSystemSolveroperator= (const LinearSystemSolver &)=delete
 
 LinearSystemSolver (LinearSystemSolver &&)=delete
 
LinearSystemSolveroperator= (LinearSystemSolver &&)=delete
 
- Public Member Functions inherited from SolverBase
 ~SolverBase () override
 
MathematicalProgramResult Solve (const MathematicalProgram &prog, const std::optional< Eigen::VectorXd > &initial_guess=std::nullopt, const std::optional< SolverOptions > &solver_options=std::nullopt) const
 Like SolverInterface::Solve(), but the result is a return value instead of an output argument. More...
 
void Solve (const MathematicalProgram &, const std::optional< Eigen::VectorXd > &, const std::optional< SolverOptions > &, MathematicalProgramResult *) const override
 Solves an optimization program with optional initial guess and solver options. More...
 
bool available () const override
 Returns true iff this solver was enabled at compile-time. More...
 
bool enabled () const override
 Returns true iff this solver is enabled at runtime. More...
 
SolverId solver_id () const override
 Returns the identifier of this solver. More...
 
bool AreProgramAttributesSatisfied (const MathematicalProgram &) const override
 Returns true if the program attributes are satisfied by the solver's capability. More...
 
 SolverBase (const SolverBase &)=delete
 
SolverBaseoperator= (const SolverBase &)=delete
 
 SolverBase (SolverBase &&)=delete
 
SolverBaseoperator= (SolverBase &&)=delete
 
- Public Member Functions inherited from SolverInterface
virtual ~SolverInterface ()
 
 SolverInterface (const SolverInterface &)=delete
 
SolverInterfaceoperator= (const SolverInterface &)=delete
 
 SolverInterface (SolverInterface &&)=delete
 
SolverInterfaceoperator= (SolverInterface &&)=delete
 

Static Public Member Functions

Static versions of the instance methods with similar names.
static SolverId id ()
 
static bool is_available ()
 
static bool is_enabled ()
 
static bool ProgramAttributesSatisfied (const MathematicalProgram &)
 

Additional Inherited Members

- Protected Member Functions inherited from SolverBase
 SolverBase (std::function< SolverId()> id, std::function< bool()> available, std::function< bool()> enabled, std::function< bool(const MathematicalProgram &)> satisfied)
 Constructs a SolverBase with the given default implementations of the solver_id(), available(), enabled(), and AreProgramAttributesSatisfied() methods. More...
 
- Protected Member Functions inherited from SolverInterface
 SolverInterface ()
 

Constructor & Destructor Documentation

◆ LinearSystemSolver() [1/3]

LinearSystemSolver ( const LinearSystemSolver )
delete

◆ LinearSystemSolver() [2/3]

◆ LinearSystemSolver() [3/3]

◆ ~LinearSystemSolver()

~LinearSystemSolver ( )
final

Member Function Documentation

◆ id()

static SolverId id ( )
static

◆ is_available()

static bool is_available ( )
static

◆ is_enabled()

static bool is_enabled ( )
static

◆ operator=() [1/2]

LinearSystemSolver& operator= ( LinearSystemSolver &&  )
delete

◆ operator=() [2/2]

LinearSystemSolver& operator= ( const LinearSystemSolver )
delete

◆ ProgramAttributesSatisfied()

static bool ProgramAttributesSatisfied ( const MathematicalProgram )
static

◆ Solve() [1/2]

void Solve
override

◆ Solve() [2/2]

Like SolverInterface::Solve(), but the result is a return value instead of an output argument.


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