iRoCS Toolbox  1.1.0
Public Member Functions
svt::GridAxis Class Reference

#include <GridAxis.hh>

Collaboration diagram for svt::GridAxis:

Public Member Functions

 GridAxis ()
 
 GridAxis (const std::string &params)
 
bool changesKernel () const
 see setChangesKernel() for Details More...
 
const std::string & keyName () const
 Name of key belonging to this axis. More...
 
size_t nValues () const
 number of values that belong to this axis More...
 
void parseString (const std::string &params)
 parse specification for grid axis from string. More...
 
void setChangesKernel (bool f)
 specify, wether kernel is affected from this key or not. More...
 
double value (size_t index) const
 value[index] More...
 

Detailed Description

Definition at line 60 of file GridAxis.hh.

Constructor & Destructor Documentation

◆ GridAxis() [1/2]

svt::GridAxis::GridAxis ( )
inline

Definition at line 63 of file GridAxis.hh.

◆ GridAxis() [2/2]

svt::GridAxis::GridAxis ( const std::string &  params)
inline

Definition at line 67 of file GridAxis.hh.

Member Function Documentation

◆ parseString()

void svt::GridAxis::parseString ( const std::string &  params)

parse specification for grid axis from string.

Syntax is <keyname>:<changesKernel>:<valuespec>

with <keyname> the name of the key, e.g. "cost" <changesKernel> flag, wether this parametrer changes the kernel, e.g. "t" or "f" <valuespec> specificaion of values, which can be

linear, e.g., "1,add1,5" –> values: 1,2,3,4,5 exponential, e.g., "1,mul2,16" –> values: 1,2,4,8,16 list, e.g., "-2,5,42,3" –> values: -2,5,42,3

Parameters
paramsstring containing grid axis specification
Exceptions
ParseErrorparams-string has incorrect format

Referenced by GridAxis().

◆ keyName()

const std::string& svt::GridAxis::keyName ( ) const
inline

Name of key belonging to this axis.

Returns
key name

Definition at line 102 of file GridAxis.hh.

◆ nValues()

size_t svt::GridAxis::nValues ( ) const
inline

number of values that belong to this axis

Returns
key name

Definition at line 114 of file GridAxis.hh.

◆ value()

double svt::GridAxis::value ( size_t  index) const
inline

value[index]

Parameters
indexindex
Returns
value[index]

Definition at line 128 of file GridAxis.hh.

◆ setChangesKernel()

void svt::GridAxis::setChangesKernel ( bool  f)
inline

specify, wether kernel is affected from this key or not.

This info is required in Grid-search, to decide wether to recalculate the kernel matrix or not. E.g. changing "gamma" affects the kernel matrix, while changing "cost" does only affect the training algorithm

Parameters
fnew value for flag

Definition at line 143 of file GridAxis.hh.

◆ changesKernel()

bool svt::GridAxis::changesKernel ( ) const
inline

see setChangesKernel() for Details

Returns
changesKernel, Default is true

Definition at line 155 of file GridAxis.hh.


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