Aimsun Next Scripting: CFrankWolfeParams Class Reference
Aimsun Next Scripting  22
Public Types | Public Member Functions | List of all members
CFrankWolfeParams Class Reference
Inheritance diagram for CFrankWolfeParams:
MacroExperimentParams

Public Types

enum  fwMethod { eNormal , eConjugate }
 

Public Member Functions

 CFrankWolfeParams ()
 
 ~CFrankWolfeParams ()
 
int getMaxIterations ()
 
void setMaxIterations (int _iterations)
 
double getMaxRelativeGap ()
 
void setMaxRelativeGap (double _gap)
 
fwMethod getFrankWolfeMethod ()
 
void setFrankWolfeMethod (fwMethod _method)
 
bool validParameters (GKModel *iModel) const
 
QString getTypeName () const
 
- Public Member Functions inherited from MacroExperimentParams
 if (base)
 
Py_END_ALLOW_THREADS End MacroExperimentParams ()
 
 ~MacroExperimentParams ()
 
virtual QString getTypeName () const =0
 
virtual bool validParameters (GKModel *iModel) const =0
 

Additional Inherited Members

- Public Attributes inherited from MacroExperimentParams
ConvertToSubClassCode Py_BEGIN_ALLOW_THREADS MacroExperimentParamsbase = (MacroExperimentParams*)sipCpp
 
 sipType = 0
 

Detailed Description

This Class provides the Frank-Wolfe parameters that can be configured

Member Enumeration Documentation

◆ fwMethod

Enumerator
eNormal 
eConjugate 

Constructor & Destructor Documentation

◆ CFrankWolfeParams()

CFrankWolfeParams::CFrankWolfeParams ( )

CFrankWolfeParams constructor

◆ ~CFrankWolfeParams()

CFrankWolfeParams::~CFrankWolfeParams ( )

CFrankWolfeParams destructor

Member Function Documentation

◆ getFrankWolfeMethod()

fwMethod CFrankWolfeParams::getFrankWolfeMethod ( )

Get the Frank Wolve Method to be used

◆ getMaxIterations()

int CFrankWolfeParams::getMaxIterations ( )

Get the maximum number of iterations used as a stopping criterion

◆ getMaxRelativeGap()

double CFrankWolfeParams::getMaxRelativeGap ( )

Get the relative gap used as stopping criterion

◆ getTypeName()

QString CFrankWolfeParams::getTypeName ( ) const
virtual

Gets name of the type of Static Assignment

Implements MacroExperimentParams.

◆ setFrankWolfeMethod()

void CFrankWolfeParams::setFrankWolfeMethod ( fwMethod  _method)

Set the Frank&Wolfe Method to be used eNormal or eConjugate

◆ setMaxIterations()

void CFrankWolfeParams::setMaxIterations ( int  _iterations)

Set the maximum number of iterations used as a stopping criterion

◆ setMaxRelativeGap()

void CFrankWolfeParams::setMaxRelativeGap ( double  _gap)

Set the maximum relative gap used as a stopping criterion

◆ validParameters()

bool CFrankWolfeParams::validParameters ( GKModel iModel) const
virtual

Check whether the parameters set are valid or not

Implements MacroExperimentParams.

© Aimsun SLU
Aimsun ®