humoto
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
humoto::SolverGuessSolutionActiveSet< t_SolverParameters > Class Template Referenceabstract

Detailed Description

template<class t_SolverParameters>
class humoto::SolverGuessSolutionActiveSet< t_SolverParameters >

Solver class with active set and solution guessing.

Template Parameters
t_SolverParametersclass representing parameters of the solver, should inherit from SolverParametersBase

Definition at line 545 of file solver.h.

#include <solver.h>

Inheritance diagram for humoto::SolverGuessSolutionActiveSet< t_SolverParameters >:
Inheritance graph

Public Member Functions

void setParameters (const t_SolverParameters &parameters)
 Construct solver with specified parameters. More...
 
void solve (humoto::Solution &solution, const humoto::OptimizationProblem &hierarchy)
 Solve an optimization problem (using previously specified parameters) More...
 
void solve (humoto::Solution &solution, const humoto::OptimizationProblem &hierarchy, const t_SolverParameters &parameters)
 Solve an optimization problem (using previously specified parameters) More...
 
void solve (humoto::Solution &solution, const humoto::OptimizationProblem &hierarchy, const humoto::Solution &solution_guess)
 Solve an optimization problem (using previously specified parameters) More...
 
void solve (Solution &solution, ActiveSet &active_set, const humoto::OptimizationProblem &hierarchy, const ActiveSet &active_set_guess)
 Solve an optimization problem (using previously specified parameters) More...
 
void solve (Solution &solution, const humoto::OptimizationProblem &hierarchy, const ActiveSet &active_set_guess)
 Solve an optimization problem (using previously specified parameters) More...
 
void solve (humoto::Solution &solution, humoto::ActiveSet &active_set, const humoto::OptimizationProblem &hierarchy)
 Solve an optimization problem (using previously specified parameters) More...
 
void solve (Solution &solution, ActiveSet &active_set, const humoto::OptimizationProblem &hierarchy, const humoto::Solution &solution_guess, const ActiveSet &active_set_guess)
 Solve an optimization problem (using previously specified parameters) More...
 
void solve (Solution &solution, const humoto::OptimizationProblem &hierarchy, const humoto::Solution &solution_guess, const ActiveSet &active_set_guess)
 Solve an optimization problem (using previously specified parameters) More...
 
void solve (humoto::Solution &solution, humoto::ActiveSet &active_set, const humoto::OptimizationProblem &hierarchy, const humoto::Solution &solution_guess)
 Solve an optimization problem (using previously specified parameters) More...
 

Protected Member Functions

 SolverGuessSolutionActiveSet ()
 
 ~SolverGuessSolutionActiveSet ()
 Protected destructor: prevent destruction of the child classes through a base pointer. More...
 
virtual void checkInputs (const humoto::OptimizationProblem &hierarchy) const
 Checks input, does nothing by default, may include extra checks in mixins. More...
 
void checkResults (const humoto::Solution &solution) const
 Check return status and crash if it indicates a failure and crashing is enabled. More...
 
virtual void getActiveSet (humoto::ActiveSet &active_set, const humoto::OptimizationProblem &hierarchy)=0
 Get active set. More...
 
virtual void initialize (const humoto::OptimizationProblem &hierarchy, const humoto::SolutionStructure &sol_structure)=0
 Initialize solver. More...
 
virtual void reset ()
 Reset solver. More...
 
virtual void setActiveSet (const humoto::ActiveSet &active_set, const humoto::OptimizationProblem &hierarchy)=0
 Set active set guess. More...
 
virtual void setSolutionGuess (const humoto::Solution &solution_guess)=0
 Set solution guess. More...
 
virtual void solveHierarchy (humoto::Solution &solution, const humoto::OptimizationProblem &hierarchy)=0
 Solve the hierarchy. More...
 

Protected Attributes

t_SolverParameters parameters_
 

Constructor & Destructor Documentation

◆ ~SolverGuessSolutionActiveSet()

template<class t_SolverParameters>
humoto::SolverGuessSolutionActiveSet< t_SolverParameters >::~SolverGuessSolutionActiveSet ( )
inlineprotected

Protected destructor: prevent destruction of the child classes through a base pointer.

Definition at line 556 of file solver.h.

◆ SolverGuessSolutionActiveSet()

template<class t_SolverParameters>
humoto::SolverGuessSolutionActiveSet< t_SolverParameters >::SolverGuessSolutionActiveSet ( )
inlineprotected

Definition at line 557 of file solver.h.

Member Function Documentation

◆ checkInputs()

template<class t_SolverParameters>
virtual void humoto::Solver< t_SolverParameters >::checkInputs ( const humoto::OptimizationProblem hierarchy) const
inlineprotectedvirtualinherited

Checks input, does nothing by default, may include extra checks in mixins.

Parameters
[in]hierarchy

Reimplemented in humoto::QPSolverMixin< humoto::Solver< SolverParameters > >, and humoto::QPSolverMixin< humoto::SolverGuessSolutionActiveSet< SolverParameters > >.

Definition at line 102 of file solver.h.

◆ checkResults()

template<class t_SolverParameters>
void humoto::Solver< t_SolverParameters >::checkResults ( const humoto::Solution solution) const
inlineprotectedinherited

Check return status and crash if it indicates a failure and crashing is enabled.

Parameters
[in]solution

Definition at line 85 of file solver.h.

◆ getActiveSet()

virtual void humoto::SolverGuessActiveSetMixin< Solver< t_SolverParameters > >::getActiveSet ( humoto::ActiveSet active_set,
const humoto::OptimizationProblem hierarchy 
)
protectedpure virtualinherited

Get active set.

Parameters
[out]active_set
[in]hierarchy

◆ initialize()

template<class t_SolverParameters>
virtual void humoto::Solver< t_SolverParameters >::initialize ( const humoto::OptimizationProblem hierarchy,
const humoto::SolutionStructure sol_structure 
)
protectedpure virtualinherited

Initialize solver.

Parameters
[in]hierarchyhierarchy
[in]sol_structuresolution structure

Implemented in humoto::qpoases::Solver, humoto::kktsolver::Solver, humoto::qpmad::Solver, and humoto::quadprogpp::Solver.

◆ reset()

template<class t_SolverParameters>
virtual void humoto::Solver< t_SolverParameters >::reset ( )
inlineprotectedvirtualinherited

Reset solver.

Reimplemented in humoto::qpoases::Solver.

Definition at line 110 of file solver.h.

◆ setActiveSet()

virtual void humoto::SolverGuessActiveSetMixin< Solver< t_SolverParameters > >::setActiveSet ( const humoto::ActiveSet active_set,
const humoto::OptimizationProblem hierarchy 
)
protectedpure virtualinherited

Set active set guess.

Parameters
[in]hierarchy
[in]active_set

◆ setParameters()

template<class t_SolverParameters>
void humoto::Solver< t_SolverParameters >::setParameters ( const t_SolverParameters &  parameters)
inlineinherited

Construct solver with specified parameters.

Parameters
[in]parametersparameters

Definition at line 141 of file solver.h.

◆ setSolutionGuess()

virtual void humoto::SolverGuessSolutionMixin< SolverGuessActiveSetMixin< Solver< t_SolverParameters > > >::setSolutionGuess ( const humoto::Solution solution_guess)
protectedpure virtualinherited

Set solution guess.

Parameters
[in]solution_guess

◆ solve() [1/9]

template<class t_SolverParameters>
void humoto::Solver< t_SolverParameters >::solve ( humoto::Solution solution,
const humoto::OptimizationProblem hierarchy 
)
inlineinherited

Solve an optimization problem (using previously specified parameters)

Parameters
[out]solution
[in]hierarchy

Definition at line 155 of file solver.h.

◆ solve() [2/9]

template<class t_SolverParameters>
void humoto::Solver< t_SolverParameters >::solve ( humoto::Solution solution,
const humoto::OptimizationProblem hierarchy,
const t_SolverParameters &  parameters 
)
inlineinherited

Solve an optimization problem (using previously specified parameters)

Parameters
[out]solution
[in]hierarchy
[in]parametersparameters

Definition at line 173 of file solver.h.

◆ solve() [3/9]

void humoto::SolverGuessSolutionMixin< SolverGuessActiveSetMixin< Solver< t_SolverParameters > > >::solve ( humoto::Solution solution,
const humoto::OptimizationProblem hierarchy,
const humoto::Solution solution_guess 
)
inlineinherited

Solve an optimization problem (using previously specified parameters)

Parameters
[out]solution
[in]hierarchy
[in]solution_guess

Definition at line 230 of file solver.h.

◆ solve() [4/9]

void humoto::SolverGuessActiveSetMixin< Solver< t_SolverParameters > >::solve ( Solution solution,
ActiveSet active_set,
const humoto::OptimizationProblem hierarchy,
const ActiveSet active_set_guess 
)
inlineinherited

Solve an optimization problem (using previously specified parameters)

Parameters
[out]solution
[out]active_set
[in]hierarchy
[in]active_set_guess

Definition at line 297 of file solver.h.

◆ solve() [5/9]

void humoto::SolverGuessActiveSetMixin< Solver< t_SolverParameters > >::solve ( Solution solution,
const humoto::OptimizationProblem hierarchy,
const ActiveSet active_set_guess 
)
inlineinherited

Solve an optimization problem (using previously specified parameters)

Parameters
[out]solution
[in]hierarchy
[in]active_set_guess

Definition at line 319 of file solver.h.

◆ solve() [6/9]

void humoto::SolverGuessActiveSetMixin< Solver< t_SolverParameters > >::solve ( humoto::Solution solution,
humoto::ActiveSet active_set,
const humoto::OptimizationProblem hierarchy 
)
inlineinherited

Solve an optimization problem (using previously specified parameters)

Parameters
[out]solution
[out]active_set
[in]hierarchy

Definition at line 339 of file solver.h.

◆ solve() [7/9]

void humoto::SolverGuessSolutionActiveSetMixin< SolverGuessSolutionMixin< SolverGuessActiveSetMixin< Solver< t_SolverParameters > > > >::solve ( Solution solution,
ActiveSet active_set,
const humoto::OptimizationProblem hierarchy,
const humoto::Solution solution_guess,
const ActiveSet active_set_guess 
)
inlineinherited

Solve an optimization problem (using previously specified parameters)

Parameters
[out]solution
[out]active_set
[in]hierarchy
[in]solution_guess
[in]active_set_guess

Definition at line 393 of file solver.h.

◆ solve() [8/9]

void humoto::SolverGuessSolutionActiveSetMixin< SolverGuessSolutionMixin< SolverGuessActiveSetMixin< Solver< t_SolverParameters > > > >::solve ( Solution solution,
const humoto::OptimizationProblem hierarchy,
const humoto::Solution solution_guess,
const ActiveSet active_set_guess 
)
inlineinherited

Solve an optimization problem (using previously specified parameters)

Parameters
[out]solution
[in]hierarchy
[in]solution_guess
[in]active_set_guess

Definition at line 418 of file solver.h.

◆ solve() [9/9]

void humoto::SolverGuessSolutionActiveSetMixin< SolverGuessSolutionMixin< SolverGuessActiveSetMixin< Solver< t_SolverParameters > > > >::solve ( humoto::Solution solution,
humoto::ActiveSet active_set,
const humoto::OptimizationProblem hierarchy,
const humoto::Solution solution_guess 
)
inlineinherited

Solve an optimization problem (using previously specified parameters)

Parameters
[out]solution
[out]active_set
[in]hierarchy
[in]solution_guess

Definition at line 441 of file solver.h.

◆ solveHierarchy()

template<class t_SolverParameters>
virtual void humoto::Solver< t_SolverParameters >::solveHierarchy ( humoto::Solution solution,
const humoto::OptimizationProblem hierarchy 
)
protectedpure virtualinherited

Solve the hierarchy.

Parameters
[out]solutionsolution
[in]hierarchyhierarchy

Implemented in humoto::qpoases::Solver, humoto::kktsolver::Solver, humoto::qpmad::Solver, and humoto::quadprogpp::Solver.

Member Data Documentation

◆ parameters_

template<class t_SolverParameters>
t_SolverParameters humoto::Solver< t_SolverParameters >::parameters_
protectedinherited

Definition at line 67 of file solver.h.


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