Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Fixed a few doc warnings
  • Loading branch information
lisitsyn committed Aug 11, 2012
1 parent cc1c80d commit 98c9256
Show file tree
Hide file tree
Showing 30 changed files with 51 additions and 21 deletions.
1 change: 1 addition & 0 deletions src/shogun/classifier/AveragedPerceptron.h
Expand Up @@ -30,6 +30,7 @@ namespace shogun
class CAveragedPerceptron : public CLinearMachine
{
public:
/** problem type */
MACHINE_PROBLEM_TYPE(PT_BINARY);

/** default constructor */
Expand Down
2 changes: 2 additions & 0 deletions src/shogun/classifier/NearestCentroid.h
Expand Up @@ -33,6 +33,8 @@ class CDistanceMachine;
class CNearestCentroid : public CDistanceMachine{

public:

/** problem type */
MACHINE_PROBLEM_TYPE(PT_MULTICLASS);

/**
Expand Down
2 changes: 2 additions & 0 deletions src/shogun/classifier/Perceptron.h
Expand Up @@ -30,6 +30,8 @@ namespace shogun
class CPerceptron : public CLinearMachine
{
public:

/** problem type */
MACHINE_PROBLEM_TYPE(PT_BINARY);

/** default constructor */
Expand Down
2 changes: 2 additions & 0 deletions src/shogun/classifier/PluginEstimate.h
Expand Up @@ -34,6 +34,8 @@ namespace shogun
class CPluginEstimate: public CMachine
{
public:

/** problem type */
MACHINE_PROBLEM_TYPE(PT_BINARY);

/** default constructor
Expand Down
7 changes: 4 additions & 3 deletions src/shogun/classifier/svm/LatentLinearMachine.h
Expand Up @@ -21,16 +21,17 @@ namespace shogun
{

public:

/** problem type */
MACHINE_PROBLEM_TYPE(PT_LATENT);

/** default contstructor */
CLatentLinearMachine();

/** constructor
*
* @param C constant C
* @param traindat training features
* @param trainlab labels for training features
* @param model latent model
* @param C regularization coefficient
*/
CLatentLinearMachine(CLatentModel* model, float64_t C);

Expand Down
13 changes: 2 additions & 11 deletions src/shogun/classifier/svm/OnlineLibLinear.h
Expand Up @@ -27,6 +27,8 @@ namespace shogun
class COnlineLibLinear : public COnlineLinearMachine
{
public:

/** problem type */
MACHINE_PROBLEM_TYPE(PT_BINARY);

/** Default constructor */
Expand Down Expand Up @@ -117,17 +119,6 @@ class COnlineLibLinear : public COnlineLinearMachine
* @param label label of this example
*/
virtual void train_one(SGVector<float32_t> ex, float64_t label);
protected:

/**
* Train classifier
*
* @param data Training data, can be avoided if already
* initialized with it
*
* @return Whether training was successful
*/
//virtual bool train_machine(CFeatures* data=NULL);

private:
/** Set up parameters */
Expand Down
2 changes: 2 additions & 0 deletions src/shogun/classifier/svm/SGDQN.h
Expand Up @@ -34,6 +34,8 @@ namespace shogun
class CSGDQN : public CLinearMachine
{
public:

/** problem type */
MACHINE_PROBLEM_TYPE(PT_BINARY);

/** default constructor */
Expand Down
2 changes: 2 additions & 0 deletions src/shogun/classifier/svm/SVM.h
Expand Up @@ -47,6 +47,8 @@ class CMulticlassSVM;
class CSVM : public CKernelMachine
{
public:

/** problem type */
MACHINE_PROBLEM_TYPE(PT_BINARY);

/** Create an empty Support Vector Machine Object
Expand Down
2 changes: 2 additions & 0 deletions src/shogun/classifier/svm/SVMLin.h
Expand Up @@ -22,6 +22,8 @@ namespace shogun
class CSVMLin : public CLinearMachine
{
public:

/** problem type */
MACHINE_PROBLEM_TYPE(PT_BINARY);

/** default constructor */
Expand Down
2 changes: 2 additions & 0 deletions src/shogun/classifier/svm/SVMOcas.h
Expand Up @@ -32,6 +32,8 @@ enum E_SVM_TYPE
class CSVMOcas : public CLinearMachine
{
public:

/** problem type */
MACHINE_PROBLEM_TYPE(PT_BINARY);

/** default constructor */
Expand Down
2 changes: 2 additions & 0 deletions src/shogun/classifier/svm/SVMSGD.h
Expand Up @@ -34,6 +34,8 @@ namespace shogun
class CSVMSGD : public CLinearMachine
{
public:

/** problem type */
MACHINE_PROBLEM_TYPE(PT_BINARY);

/** default constructor */
Expand Down
2 changes: 2 additions & 0 deletions src/shogun/classifier/svm/SubGradientSVM.h
Expand Up @@ -23,6 +23,8 @@ namespace shogun
class CSubGradientSVM : public CLinearMachine
{
public:

/** problem type */
MACHINE_PROBLEM_TYPE(PT_BINARY);

/** default constructor */
Expand Down
5 changes: 5 additions & 0 deletions src/shogun/classifier/svm/WDSVMOcas.h
Expand Up @@ -26,6 +26,7 @@ template <class ST> class CStringFeatures;
class CWDSVMOcas : public CMachine
{
public:
/** problem type */
MACHINE_PROBLEM_TYPE(PT_BINARY);

/** default constructor */
Expand Down Expand Up @@ -220,6 +221,10 @@ class CWDSVMOcas : public CMachine

protected:

/** get real outputs
*
* @param data features to apply for
*/
SGVector<float64_t> apply_get_outputs(CFeatures* data);

/** set wd weights
Expand Down
2 changes: 2 additions & 0 deletions src/shogun/classifier/vw/VowpalWabbit.h
Expand Up @@ -38,6 +38,8 @@ namespace shogun
class CVowpalWabbit: public COnlineLinearMachine
{
public:

/** problem type */
MACHINE_PROBLEM_TYPE(PT_BINARY);

/**
Expand Down
1 change: 1 addition & 0 deletions src/shogun/clustering/Hierarchical.h
Expand Up @@ -48,6 +48,7 @@ class CHierarchical : public CDistanceMachine
CHierarchical(int32_t merges, CDistance* d);
virtual ~CHierarchical();

/** problem type */
MACHINE_PROBLEM_TYPE(PT_MULTICLASS);

/** get classifier type
Expand Down
2 changes: 1 addition & 1 deletion src/shogun/kernel/Kernel.h
Expand Up @@ -763,7 +763,7 @@ class CKernel : public CSGObject
*
* @param param the parameter
* @param obj the object that owns the parameter
* @index index the index of the element if parameter is a vector
* @param index index the index of the element if parameter is a vector
*
* @return gradient with respect to parameter
*/
Expand Down
2 changes: 1 addition & 1 deletion src/shogun/kernel/LinearARDKernel.h
Expand Up @@ -116,7 +116,7 @@ class CLinearARDKernel: public CDotKernel
*
* @param param the parameter
* @param obj the object that owns the parameter
* @index index the index of the element if parameter is a vector
* @param index index the index of the element if parameter is a vector
*
* @return gradient with respect to parameter
*/
Expand Down
2 changes: 1 addition & 1 deletion src/shogun/kernel/ProductKernel.h
Expand Up @@ -255,7 +255,7 @@ class CProductKernel : public CKernel
*
* @param param the parameter
* @param obj the object that owns the parameter
* @index index the index of the element if parameter is a vector
* @param index index the index of the element if parameter is a vector
*
* @return gradient with respect to parameter
*/
Expand Down
1 change: 1 addition & 0 deletions src/shogun/machine/StructuredOutputMachine.h
Expand Up @@ -26,6 +26,7 @@ class CLossFunction;
class CStructuredOutputMachine : public CMachine
{
public:
/** problem type */
MACHINE_PROBLEM_TYPE(PT_STRUCTURED);

/** deafult constructor */
Expand Down
4 changes: 2 additions & 2 deletions src/shogun/modelselection/GradientModelSelection.h
Expand Up @@ -29,8 +29,8 @@ class CGradientModelSelection: public CModelSelection
public:

/** constructor
* @param model_parameters
* @param cross_validation
* @param model_parameters model parameters
* @param machine_eval machine evaluation
*/
CGradientModelSelection(CModelSelectionParameters* model_parameters,
CMachineEvaluation* machine_eval);
Expand Down
4 changes: 2 additions & 2 deletions src/shogun/modelselection/GridSearchModelSelection.h
Expand Up @@ -31,8 +31,8 @@ class CGridSearchModelSelection: public CModelSelection
CGridSearchModelSelection();

/** constructor
* @param model_parameters
* @param cross_validation
* @param model_parameters model parameters
* @param machine_eval machine evaluation
*/
CGridSearchModelSelection(CModelSelectionParameters* model_parameters,
CMachineEvaluation* machine_eval);
Expand Down
1 change: 1 addition & 0 deletions src/shogun/multiclass/MulticlassSVM.h
Expand Up @@ -26,6 +26,7 @@ class CSVM;
class CMulticlassSVM : public CKernelMulticlassMachine
{
public:
/** problem type */
MACHINE_PROBLEM_TYPE(PT_MULTICLASS);

/** default constructor */
Expand Down
2 changes: 2 additions & 0 deletions src/shogun/regression/GaussianProcessRegression.h
Expand Up @@ -30,8 +30,10 @@ class CGaussianProcessRegression : public CMachine
{

public:
/** problem type */
MACHINE_PROBLEM_TYPE(PT_REGRESSION);

/** GP return type */
enum EGPReturnType
{
GP_RETURN_MEANS,
Expand Down
1 change: 1 addition & 0 deletions src/shogun/regression/KernelRidgeRegression.h
Expand Up @@ -64,6 +64,7 @@ enum ETrainingType
class CKernelRidgeRegression : public CKernelMachine
{
public:
/** problem type */
MACHINE_PROBLEM_TYPE(PT_REGRESSION);

/** default constructor */
Expand Down
1 change: 1 addition & 0 deletions src/shogun/regression/LeastAngleRegression.h
Expand Up @@ -72,6 +72,7 @@ class CFeatures;
class CLeastAngleRegression: public CLinearMachine
{
public:
/** problem type */
MACHINE_PROBLEM_TYPE(PT_REGRESSION);

/** default constructor
Expand Down
1 change: 1 addition & 0 deletions src/shogun/regression/LeastSquaresRegression.h
Expand Up @@ -40,6 +40,7 @@ namespace shogun
class CLeastSquaresRegression : public CLinearRidgeRegression
{
public:
/** problem type */
MACHINE_PROBLEM_TYPE(PT_REGRESSION);

/** default constructor */
Expand Down
1 change: 1 addition & 0 deletions src/shogun/regression/LinearRidgeRegression.h
Expand Up @@ -42,6 +42,7 @@ namespace shogun
class CLinearRidgeRegression : public CLinearMachine
{
public:
/** problem type */
MACHINE_PROBLEM_TYPE(PT_REGRESSION);

/** default constructor */
Expand Down
1 change: 1 addition & 0 deletions src/shogun/regression/svr/LibSVR.h
Expand Up @@ -51,6 +51,7 @@ namespace shogun
class CLibSVR : public CSVM
{
public:
/** problem type */
MACHINE_PROBLEM_TYPE(PT_REGRESSION);

/** default constructor */
Expand Down
1 change: 1 addition & 0 deletions src/shogun/regression/svr/MKLRegression.h
Expand Up @@ -25,6 +25,7 @@ namespace shogun
class CMKLRegression : public CMKL
{
public:
/** problem type */
MACHINE_PROBLEM_TYPE(PT_REGRESSION);

/** Constructor
Expand Down
1 change: 1 addition & 0 deletions src/shogun/regression/svr/SVRLight.h
Expand Up @@ -62,6 +62,7 @@ namespace shogun
class CSVRLight: public CSVMLight
{
public:
/** problem type */
MACHINE_PROBLEM_TYPE(PT_REGRESSION);

/** default constructor */
Expand Down

0 comments on commit 98c9256

Please sign in to comment.