DART  6.10.1
dart::optimizer::snopt::SnoptSolver Class Referenceabstract

#include <SnoptSolver.hpp>

Inheritance diagram for dart::optimizer::snopt::SnoptSolver:
dart::optimizer::Solver

Public Member Functions

 SnoptSolver (Problem *problem)
 
virtual ~SnoptSolver ()
 
virtual bool solve ()
 Solve optimization problem. More...
 
virtual void resetSolver ()
 
virtual std::string getType () const =0
 Get the type (implementation) of this Solver. More...
 
virtual std::shared_ptr< Solverclone () const =0
 Create an identical clone of this Solver. More...
 
void setProperties (const Properties &_properties)
 Set the generic Properties of this Solver. More...
 
const PropertiesgetSolverProperties () const
 Get the generic Properties of this Solver. More...
 
void copy (const Solver &_otherSolver)
 Copy the generic Properties of another Solver. More...
 
virtual void setProblem (std::shared_ptr< Problem > _newProblem)
 Set the nonlinear optimization problem. More...
 
std::shared_ptr< ProblemgetProblem () const
 Get nonlinear optimization problem. More...
 
virtual void setTolerance (double _newTolerance)
 Set the maximum step size allowed for the Problem to be considered converged. More...
 
double getTolerance () const
 Get the maximum step size allowed for the Problem to be considered converged. More...
 
virtual void setNumMaxIterations (std::size_t _newMax)
 Set the maximum number of iterations that the Solver should use. More...
 
std::size_t getNumMaxIterations () const
 Get the maximum number of iterations that the Solver should use. More...
 
virtual void setIterationsPerPrint (std::size_t _newRatio)
 Set the number of iterations that should pass between printing progress to the terminal. More...
 
std::size_t getIterationsPerPrint () const
 Get the number of iterations that should pass between printing progress to the terminal. More...
 
virtual void setOutStream (std::ostream *_os)
 Set the output stream that prints the Solver's progress. More...
 
std::ostream * getOutStream () const
 Get the output stream that prints the Solver's progress. More...
 
virtual void setPrintFinalResult (bool _print)
 Set to true if the final result should be printed to the terminal. More...
 
bool getPrintFinalResult () const
 Returns true if the final result should be printed to the terminal. More...
 
virtual void setResultFileName (const std::string &_resultFile)
 Set the name of the file that results should be printed to. More...
 
const std::string & getResultFileName () const
 Get the name of the file that results should be printed to. More...
 

Static Public Member Functions

static int iterUpdate (long mask, int compute_gradients, double *coefs, void *update_data)
 

Protected Attributes

Properties mProperties
 

Private Member Functions

ConstraintSet * conBox ()
 
ObjectiveSet * objBox ()
 

Private Attributes

SnoptInterfacemSnopt
 
bool mNoDisplay
 
int mSolverIter
 
int mTotalDofs
 
int mOptCount
 
bool mPrint
 
int mUnit
 

Constructor & Destructor Documentation

◆ SnoptSolver()

dart::optimizer::snopt::SnoptSolver::SnoptSolver ( Problem problem)

◆ ~SnoptSolver()

dart::optimizer::snopt::SnoptSolver::~SnoptSolver ( )
virtual

Member Function Documentation

◆ clone()

virtual std::shared_ptr<Solver> dart::optimizer::Solver::clone ( ) const
pure virtualinherited

◆ conBox()

ConstraintSet * dart::optimizer::snopt::SnoptSolver::conBox ( )
private

◆ copy()

void dart::optimizer::Solver::copy ( const Solver _otherSolver)
inherited

Copy the generic Properties of another Solver.

◆ getIterationsPerPrint()

std::size_t dart::optimizer::Solver::getIterationsPerPrint ( ) const
inherited

Get the number of iterations that should pass between printing progress to the terminal.

A value of 0 means there will be no printing.

◆ getNumMaxIterations()

std::size_t dart::optimizer::Solver::getNumMaxIterations ( ) const
inherited

Get the maximum number of iterations that the Solver should use.

◆ getOutStream()

std::ostream * dart::optimizer::Solver::getOutStream ( ) const
inherited

Get the output stream that prints the Solver's progress.

◆ getPrintFinalResult()

bool dart::optimizer::Solver::getPrintFinalResult ( ) const
inherited

Returns true if the final result should be printed to the terminal.

◆ getProblem()

std::shared_ptr< Problem > dart::optimizer::Solver::getProblem ( ) const
inherited

Get nonlinear optimization problem.

◆ getResultFileName()

const std::string & dart::optimizer::Solver::getResultFileName ( ) const
inherited

Get the name of the file that results should be printed to.

An empty string indicates that results should not be printed to a file.

◆ getSolverProperties()

const Solver::Properties & dart::optimizer::Solver::getSolverProperties ( ) const
inherited

Get the generic Properties of this Solver.

◆ getTolerance()

double dart::optimizer::Solver::getTolerance ( ) const
inherited

Get the maximum step size allowed for the Problem to be considered converged.

◆ getType()

virtual std::string dart::optimizer::Solver::getType ( ) const
pure virtualinherited

◆ iterUpdate()

int dart::optimizer::snopt::SnoptSolver::iterUpdate ( long  mask,
int  compute_gradients,
double *  coefs,
void *  update_data 
)
static

◆ objBox()

ObjectiveSet * dart::optimizer::snopt::SnoptSolver::objBox ( )
private

◆ resetSolver()

void dart::optimizer::snopt::SnoptSolver::resetSolver ( )
virtual

◆ setIterationsPerPrint()

void dart::optimizer::Solver::setIterationsPerPrint ( std::size_t  _newRatio)
virtualinherited

Set the number of iterations that should pass between printing progress to the terminal.

Use 0 for no printing.

◆ setNumMaxIterations()

void dart::optimizer::Solver::setNumMaxIterations ( std::size_t  _newMax)
virtualinherited

Set the maximum number of iterations that the Solver should use.

◆ setOutStream()

void dart::optimizer::Solver::setOutStream ( std::ostream *  _os)
virtualinherited

Set the output stream that prints the Solver's progress.

◆ setPrintFinalResult()

void dart::optimizer::Solver::setPrintFinalResult ( bool  _print)
virtualinherited

Set to true if the final result should be printed to the terminal.

◆ setProblem()

void dart::optimizer::Solver::setProblem ( std::shared_ptr< Problem _newProblem)
virtualinherited

Set the nonlinear optimization problem.

◆ setProperties()

void dart::optimizer::Solver::setProperties ( const Properties _properties)
inherited

Set the generic Properties of this Solver.

◆ setResultFileName()

void dart::optimizer::Solver::setResultFileName ( const std::string &  _resultFile)
virtualinherited

Set the name of the file that results should be printed to.

Use an empty string to indicate that results should not be printed to a file.

◆ setTolerance()

void dart::optimizer::Solver::setTolerance ( double  _newTolerance)
virtualinherited

Set the maximum step size allowed for the Problem to be considered converged.

◆ solve()

bool dart::optimizer::snopt::SnoptSolver::solve ( )
virtual

Solve optimization problem.

Implements dart::optimizer::Solver.

Member Data Documentation

◆ mNoDisplay

bool dart::optimizer::snopt::SnoptSolver::mNoDisplay
private

◆ mOptCount

int dart::optimizer::snopt::SnoptSolver::mOptCount
private

◆ mPrint

bool dart::optimizer::snopt::SnoptSolver::mPrint
private

◆ mProperties

Properties dart::optimizer::Solver::mProperties
protectedinherited

◆ mSnopt

SnoptInterface* dart::optimizer::snopt::SnoptSolver::mSnopt
private

◆ mSolverIter

int dart::optimizer::snopt::SnoptSolver::mSolverIter
private

◆ mTotalDofs

int dart::optimizer::snopt::SnoptSolver::mTotalDofs
private

◆ mUnit

int dart::optimizer::snopt::SnoptSolver::mUnit
private