MyMediaLite  3.10
Public Member Functions | List of all members
RecommenderParameters Class Reference

Class for key-value pair string processing More...

Public Member Functions

bool CheckForLeftovers ()
 Check for parameters that have not been processed yet
bool GetRemoveBool (string key)
 Get the value of a boolean parameter from the collection and remove the corresponding key-value pair
bool GetRemoveBool (string key, bool dvalue)
 Get the value of a boolean parameter from the collection and remove the corresponding key-value pair
double GetRemoveDouble (string key)
 Get a double value from the parameters
double GetRemoveDouble (string key, double dvalue)
 Get a double value from the parameters
float GetRemoveFloat (string key)
 Get a float value from the parameters
float GetRemoveFloat (string key, float dvalue)
 Get a float value from the parameters
int GetRemoveInt32 (string key)
 Get the value of an integer parameter from the collection and remove the corresponding key-value pair
int GetRemoveInt32 (string key, int dvalue)
 Get the value of an integer parameter from the collection and remove the corresponding key-value pair
IList< int > GetRemoveInt32List (string key)
 Get the values of an integer list parameter from the collection and remove the corresponding key-value pair
IList< int > GetRemoveInt32List (string key, char sep)
 Get the values of an integer list parameter from the collection and remove the corresponding key-value pair
string GetRemoveString (string key)
 Get a string parameter
string GetRemoveString (string key, string dvalue)
 Get a string parameter
uint GetRemoveUInt32 (string key)
 Get and remove an unsigned integer
uint GetRemoveUInt32 (string key, uint dvalue)
 Get and remove an unsigned integer
 RecommenderParameters (string arg_string)
 Create a CommandLineParameters object
 RecommenderParameters (IList< string > args, int start)
 Create a RecommenderParameters object

Detailed Description

Class for key-value pair string processing

Constructor & Destructor Documentation

RecommenderParameters ( string  arg_string)
inline

Create a CommandLineParameters object

Parameters
arg_stringa string that contains the command line parameters
RecommenderParameters ( IList< string >  args,
int  start 
)
inline

Create a RecommenderParameters object

Parameters
argsa list of strings that contains the command line parameters
startignore all parameters before this position

Member Function Documentation

bool CheckForLeftovers ( )
inline

Check for parameters that have not been processed yet

Returns
true if there are leftovers
bool GetRemoveBool ( string  key)
inline

Get the value of a boolean parameter from the collection and remove the corresponding key-value pair

Parameters
keythe name of the parameter
Returns
the value of the parameter if it exists, false otherwise
bool GetRemoveBool ( string  key,
bool  dvalue 
)
inline

Get the value of a boolean parameter from the collection and remove the corresponding key-value pair

Parameters
keythe name of the parameter
dvaluethe default value of the parameter
Returns
the value of the parameter if it exists, the default otherwise
double GetRemoveDouble ( string  key)
inline

Get a double value from the parameters

Parameters
keythe parameter name
Returns
the value of the parameter, 0 if no parameter of the given name found
double GetRemoveDouble ( string  key,
double  dvalue 
)
inline

Get a double value from the parameters

Parameters
keythe parameter name
dvaluethe default value if parameter of the given name is not found
Returns
the value of the parameter if it is found, the default value otherwise
float GetRemoveFloat ( string  key)
inline

Get a float value from the parameters

Parameters
keythe parameter name
Returns
the value of the parameter, 0 if no parameter of the given name found
float GetRemoveFloat ( string  key,
float  dvalue 
)
inline

Get a float value from the parameters

Parameters
keythe parameter name
dvaluethe default value if parameter of the given name is not found
Returns
the value of the parameter if it is found, the default value otherwise
int GetRemoveInt32 ( string  key)
inline

Get the value of an integer parameter from the collection and remove the corresponding key-value pair

Parameters
keythe name of the parameter
Returns
the value of the parameter if it exists, 0 otherwise
int GetRemoveInt32 ( string  key,
int  dvalue 
)
inline

Get the value of an integer parameter from the collection and remove the corresponding key-value pair

Parameters
keythe name of the parameter
dvaluethe default value of the parameter
Returns
the value of the parameter if it exists, the default otherwise
IList<int> GetRemoveInt32List ( string  key)
inline

Get the values of an integer list parameter from the collection and remove the corresponding key-value pair

Parameters
keythe name of the parameter
Returns
the values of the parameter if it exists, an empty list otherwise
IList<int> GetRemoveInt32List ( string  key,
char  sep 
)
inline

Get the values of an integer list parameter from the collection and remove the corresponding key-value pair

Parameters
keythe name of the parameter
septhe separator character used to split the string representation of the list
Returns
the values of the parameter if it exists, the default otherwise
string GetRemoveString ( string  key)
inline

Get a string parameter

Parameters
keythe name of the parameter
Returns
the parameter value related to key, an empty string if it does not exist
string GetRemoveString ( string  key,
string  dvalue 
)
inline

Get a string parameter

Parameters
keythe name of the parameter
dvaluethe default value
Returns
the parameter value related to key, the default value if it does not exist
uint GetRemoveUInt32 ( string  key)
inline

Get and remove an unsigned integer

Parameters
keythe parameter name
Returns
the value of the unsigned integer parameter, zero if it is not found
uint GetRemoveUInt32 ( string  key,
uint  dvalue 
)
inline

Get and remove an unsigned integer

Parameters
keythe parameter name
dvaluethe default value of the parameter
Returns
the value of the unsigned integer parameter, dvalue if it is not found

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