Drake
SolverId Class Reference

Identifies a MathematicalProgramSolverInterface implementation. More...

#include <drake/solvers/solver_id.h>

Public Member Functions

 ~SolverId ()=default
 
 SolverId (std::string name)
 Constructs a specific, known solver type. More...
 
const std::string & name () const
 
Implements CopyConstructible, CopyAssignable, MoveConstructible, MoveAssignable
 SolverId (const SolverId &)=default
 
SolverIdoperator= (const SolverId &)=default
 
 SolverId (SolverId &&)=default
 
SolverIdoperator= (SolverId &&)=default
 

Friends

struct std::less< SolverId >
 
bool operator== (const SolverId &, const SolverId &)
 
bool operator!= (const SolverId &, const SolverId &)
 

Detailed Description

Identifies a MathematicalProgramSolverInterface implementation.

A moved-from instance is guaranteed to be empty and will not compare equal to any non-empty ID.

Constructor & Destructor Documentation

SolverId ( const SolverId )
default
SolverId ( SolverId &&  )
default
~SolverId ( )
default
SolverId ( std::string  name)
explicit

Constructs a specific, known solver type.

Internally, a hidden identifier is allocated and assigned to this instance; all instances that share an identifier (including copies of this instance) are considered equal. The solver names are not enforced to be unique, though we recommend that they remain so in practice.

Here is the call graph for this function:

Member Function Documentation

const std::string& name ( ) const
inline

Here is the caller graph for this function:

SolverId& operator= ( const SolverId )
default
SolverId& operator= ( SolverId &&  )
default

Friends And Related Function Documentation

bool operator!= ( const SolverId ,
const SolverId  
)
friend
bool operator== ( const SolverId ,
const SolverId  
)
friend
friend struct std::less< SolverId >
friend

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