ArgumentTest.hpp File Reference

#include "gstlearn_export.hpp"
#include "Enum/AEnum.hpp"
#include "Basic/Utilities.hpp"
#include "Matrix/MatrixRectangular.hpp"
#include "Matrix/MatrixSquareGeneral.hpp"
#include "Matrix/MatrixSquareSymmetric.hpp"
#include "Matrix/MatrixSparse.hpp"

Classes
class	argClass

Macros
#define	ENUM_TESTS

Functions
GSTLEARN_EXPORT void	argumentTestInt (int value)
GSTLEARN_EXPORT void	argumentTestDouble (double value)
GSTLEARN_EXPORT void	argumentTestVectorInt (const VectorInt &values)
GSTLEARN_EXPORT void	argumentTestVectorDouble (const VectorDouble &values)
GSTLEARN_EXPORT void	argumentTestVectorVectorInt (const VectorVectorInt &values)
GSTLEARN_EXPORT void	argumentTestVectorVectorDouble (const VectorVectorDouble &values)
GSTLEARN_EXPORT void	argumentTestString (const String &value)
GSTLEARN_EXPORT void	argumentTestVectorString (const VectorString &values)
GSTLEARN_EXPORT void	argumentTestIntOverload (int value)
GSTLEARN_EXPORT void	argumentTestIntOverload (const VectorInt &values)
GSTLEARN_EXPORT void	argumentTestDoubleOverload (double value)
GSTLEARN_EXPORT void	argumentTestDoubleOverload (const VectorDouble &values)
GSTLEARN_EXPORT void	argumentTestStringOverload (const String &value)
GSTLEARN_EXPORT void	argumentTestStringOverload (const VectorString &values)
GSTLEARN_EXPORT void	argumentTestEnum (const ETests &value)
GSTLEARN_EXPORT int	argumentReturnInt (int value)
GSTLEARN_EXPORT double	argumentReturnDouble (double value)
GSTLEARN_EXPORT VectorInt	argumentReturnVectorInt (const VectorInt &values)
GSTLEARN_EXPORT VectorDouble	argumentReturnVectorDouble (const VectorDouble &values)
GSTLEARN_EXPORT VectorVectorInt	argumentReturnVectorVectorInt (const VectorVectorInt &values)
GSTLEARN_EXPORT VectorVectorDouble	argumentReturnVectorVectorDouble (const VectorVectorDouble &values)
GSTLEARN_EXPORT void	argumentDefTestInt (int argInt=2)
GSTLEARN_EXPORT void	argumentDefTestDbl (double argDbl=2.)
GSTLEARN_EXPORT void	argumentDefTestStr (const String &argstr="Default String")
GSTLEARN_EXPORT void	argumentDefTestVInt (const VectorInt &argVInt=VectorInt())
GSTLEARN_EXPORT void	argumentDefTestVDbl (const VectorDouble &argdVDbl=VectorDouble())
GSTLEARN_EXPORT void	argumentDefTestVString (const VectorString &argVString=VectorString())
GSTLEARN_EXPORT void	argumentDefTestVVInt (VectorVectorInt argVVInt=VectorVectorInt())
GSTLEARN_EXPORT void	argumentDefTestVVDbl (VectorVectorDouble argVVDbl=VectorVectorDouble())
GSTLEARN_EXPORT void	argumentTestMatrixRectangular (const MatrixRectangular &mat=MatrixRectangular())
GSTLEARN_EXPORT void	argumentTestMatrixSquareGeneral (const MatrixSquareGeneral &mat=MatrixSquareGeneral())
GSTLEARN_EXPORT void	argumentTestMatrixSquareSymmetric (const MatrixSquareSymmetric &mat=MatrixSquareSymmetric())
GSTLEARN_EXPORT MatrixRectangular	argumentReturnMatrix (int nrows=2, int ncols=3, int seed=1312)
GSTLEARN_EXPORT void	argumentTestMatrixSparse (const MatrixSparse &mat=MatrixSparse())
GSTLEARN_EXPORT MatrixSparse	argumentReturnMatrixSparse (int nrows=2, int ncols=3, double zeroPercent=0.1, int seed=1356)

Macro Definition Documentation

ENUM_TESTS

#define ENUM_TESTS

Value:

                   ETests, CASE0,\
                   CASE0 , 0, "Enum test case 0",\
                   CASE1 , 1, "Enum test case 1",\
                   CASE2 , 2, "Enum test case 2"

Function Documentation

argumentDefTestDbl()

GSTLEARN_EXPORT void argumentDefTestDbl

(

double

argDbl = 2.

)

argumentDefTestInt()

GSTLEARN_EXPORT void argumentDefTestInt

(

int

argInt = 2

)

argumentDefTestStr()

GSTLEARN_EXPORT void argumentDefTestStr

(

const String &

argstr = "Default String"

)

argumentDefTestVDbl()

GSTLEARN_EXPORT void argumentDefTestVDbl

(

const VectorDouble &

argdVDbl = VectorDouble()

)

argumentDefTestVInt()

GSTLEARN_EXPORT void argumentDefTestVInt

(

const VectorInt &

argVInt = VectorInt()

)

argumentDefTestVString()

GSTLEARN_EXPORT void argumentDefTestVString

(

const VectorString &

argVString = VectorString()

)

argumentDefTestVVDbl()

GSTLEARN_EXPORT void argumentDefTestVVDbl

(

VectorVectorDouble

argVVDbl = VectorVectorDouble()

)

argumentDefTestVVInt()

GSTLEARN_EXPORT void argumentDefTestVVInt

(

VectorVectorInt

argVVInt = VectorVectorInt()

)

argumentReturnDouble()

GSTLEARN_EXPORT double argumentReturnDouble

(

double

value

)

argumentReturnInt()

GSTLEARN_EXPORT int argumentReturnInt

(

int

value

)

argumentReturnMatrix()

GSTLEARN_EXPORT MatrixRectangular argumentReturnMatrix	(	int	nrows = 2,
		int	ncols = 3,
		int	seed = 1312
	)

argumentReturnMatrixSparse()

GSTLEARN_EXPORT MatrixSparse argumentReturnMatrixSparse	(	int	nrows = 2,
		int	ncols = 3,
		double	zeroPercent = 0.1,
		int	seed = 1356
	)

argumentReturnVectorDouble()

GSTLEARN_EXPORT VectorDouble argumentReturnVectorDouble

(

const VectorDouble &

values

)

argumentReturnVectorInt()

GSTLEARN_EXPORT VectorInt argumentReturnVectorInt

(

const VectorInt &

values

)

argumentReturnVectorVectorDouble()

GSTLEARN_EXPORT VectorVectorDouble argumentReturnVectorVectorDouble

(

const VectorVectorDouble &

values

)

argumentReturnVectorVectorInt()

GSTLEARN_EXPORT VectorVectorInt argumentReturnVectorVectorInt

(

const VectorVectorInt &

values

)

argumentTestDouble()

GSTLEARN_EXPORT void argumentTestDouble

(

double

value

)

Function to test Double argument

Parameters

value

Double input argument

argumentTestDoubleOverload() [1/2]

GSTLEARN_EXPORT void argumentTestDoubleOverload

(

const VectorDouble &

values

)

argumentTestDoubleOverload() [2/2]

GSTLEARN_EXPORT void argumentTestDoubleOverload

(

double

value

)

argumentTestEnum()

GSTLEARN_EXPORT void argumentTestEnum

(

const ETests &

value

)

argumentTestInt()

GSTLEARN_EXPORT void argumentTestInt

(

int

value

)

Function to test Integer argument

Parameters

value

Integer input argument

argumentTestIntOverload() [1/2]

GSTLEARN_EXPORT void argumentTestIntOverload

(

const VectorInt &

values

)

argumentTestIntOverload() [2/2]

GSTLEARN_EXPORT void argumentTestIntOverload

(

int

value

)

argumentTestMatrixRectangular()

GSTLEARN_EXPORT void argumentTestMatrixRectangular

(

const MatrixRectangular &

mat = MatrixRectangular()

)

argumentTestMatrixSparse()

GSTLEARN_EXPORT void argumentTestMatrixSparse

(

const MatrixSparse &

mat = MatrixSparse()

)

argumentTestMatrixSquareGeneral()

GSTLEARN_EXPORT void argumentTestMatrixSquareGeneral

(

const MatrixSquareGeneral &

mat = MatrixSquareGeneral()

)

argumentTestMatrixSquareSymmetric()

GSTLEARN_EXPORT void argumentTestMatrixSquareSymmetric

(

const MatrixSquareSymmetric &

mat = MatrixSquareSymmetric()

)

argumentTestString()

GSTLEARN_EXPORT void argumentTestString

(

const String &

value

)

argumentTestStringOverload() [1/2]

GSTLEARN_EXPORT void argumentTestStringOverload

(

const String &

value

)

argumentTestStringOverload() [2/2]

GSTLEARN_EXPORT void argumentTestStringOverload

(

const VectorString &

values

)

argumentTestVectorDouble()

GSTLEARN_EXPORT void argumentTestVectorDouble

(

const VectorDouble &

values

)

argumentTestVectorInt()

GSTLEARN_EXPORT void argumentTestVectorInt

(

const VectorInt &

values

)

argumentTestVectorString()

GSTLEARN_EXPORT void argumentTestVectorString

(

const VectorString &

values

)

argumentTestVectorVectorDouble()

GSTLEARN_EXPORT void argumentTestVectorVectorDouble

(

const VectorVectorDouble &

values

)

argumentTestVectorVectorInt()

GSTLEARN_EXPORT void argumentTestVectorVectorInt

(

const VectorVectorInt &

values

)