KKMLL::ClassStatistic Class Reference

Used by routines that retrieve Class statistics from FeatureVectorList instances. More...

#include <ClassStatistic.h>

Public Member Functions
	ClassStatistic (const ClassStatistic &right)
	ClassStatistic (MLClassPtr _mlClass, kkuint32 _count)
kkuint32	Count () const
void	Increment ()
MLClassPtr	MLClass () const
const KKStr &	Name () const
const ClassStatistic &	operator+= (const ClassStatistic &right)

Detailed Description

Used by routines that retrieve Class statistics from FeatureVectorList instances.

Definition at line 14 of file ClassStatistic.h.

Constructor & Destructor Documentation

ClassStatistic::ClassStatistic

(

const ClassStatistic &

right

)

Definition at line 22 of file ClassStatistic.cpp.

Referenced by KKMLL::ClassStatisticList::operator+=().

                                                           :
  mlClass (right.mlClass),
  count      (right.count)
{
}

ClassStatistic::ClassStatistic	(	MLClassPtr	_mlClass,
		kkuint32	_count
	)

Definition at line 29 of file ClassStatistic.cpp.

Referenced by KKMLL::FeatureVectorList::GetClassStatistics().

                                :
   mlClass (_mlClass),
   count      (_count)
{}

Member Function Documentation

kkuint32 KKMLL::ClassStatistic::Count ( ) const

inline

Definition at line 23 of file ClassStatistic.h.

Referenced by KKMLL::SVMparam::AvgNumOfFeatures(), KKMLL::FeatureVectorList::GetClassDistribution(), KKMLL::FeatureVectorList::MajorityClassFraction(), KKMLL::ClassStatisticList::ClassStatSortByCount::operator()(), and operator+=().

{return  count;}

void KKMLL::ClassStatistic::Increment ( )

inline

Definition at line 26 of file ClassStatistic.h.

Referenced by KKMLL::FeatureVectorList::GetClassStatistics().

{count++;}

MLClassPtr KKMLL::ClassStatistic::MLClass ( ) const

inline

Definition at line 24 of file ClassStatistic.h.

Referenced by KKMLL::SVMparam::AvgNumOfFeatures(), KKMLL::FeatureVectorList::GetClassDistribution(), KKMLL::ClassStatisticList::ClassStatisticSortComparrison::operator()(), KKMLL::ClassStatisticList::ClassStatSortByCount::operator()(), operator+=(), and KKMLL::ClassStatisticList::operator+=().

{return  mlClass;}

const KKStr & ClassStatistic::Name

(

)

const

Definition at line 38 of file ClassStatistic.cpp.

References KKB::KKStr::Concat(), KKB::KKStr::EmptyStr(), and KKMLL::MLClass::Name().

{
  if  (mlClass)
   return mlClass->Name ();
  else
   return  KKStr::EmptyStr ();
}  /* Name */

const ClassStatistic & ClassStatistic::operator+=

(

const ClassStatistic &

right

)

Definition at line 48 of file ClassStatistic.cpp.

References Count(), and MLClass().

Referenced by KKMLL::ClassStatisticList::operator+=().

{
  if  (mlClass != right.MLClass ())
  {
    cerr << std::endl << std::endl << std::endl
         << "ClassStatistic::operator+=        Class Names Do Not Match" << std::endl
         << "                LeftClass[" << mlClass->Name () << "]   RightClass["  << right.Name () << "[" << std::endl
         << std::endl;
    return  *this;
  }

  count += right.Count ();

  return  *this;
}

---

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

• C:/Users/Kurt/GitHub/KSquareLibraries/KKMachineLearning/ClassStatistic.h
• C:/Users/Kurt/GitHub/KSquareLibraries/KKMachineLearning/ClassStatistic.cpp