classias::binary_data_with_quark_base< instance_tmpl, attributes_quark_tmpl > Class Template Reference

Inheritance diagram for classias::binary_data_with_quark_base< instance_tmpl, attributes_quark_tmpl >:

classias::binary_data_base< instance_tmpl >

Detailed Description

template<class instance_tmpl, class attributes_quark_tmpl>
class classias::binary_data_with_quark_base< instance_tmpl, attributes_quark_tmpl >

A template class for a collection of binary-classification instances with a quark assigning attribute identifiers.

This class represents a data set for training a binary classifier. The class stores instances into a vector. This class implements the necessary functions num_attributes(), num_features(), and num_labels() for training algorithms. In addition, this class owns a quark to assign attribute identifiers, and overwrites num_attributes() and num_features().

Parameters:
instance_tmpl The type of an instance.
attributes_quark_tmpl The type of an attribute quark.


Public Types

typedef instance_tmpl instance_type
 The type of an instance.
typedef attributes_quark_tmpl attributes_quark_type
 The type of a feature vector.
typedef binary_data_base<
instance_tmpl > 
base_type
 The type of the base class.
typedef base_type::size_type size_type
 A type counting the number of pairs in a container.
typedef base_type::iterator iterator
 A type providing a random-access iterator.
typedef base_type::const_iterator const_iterator
 A type providing a read-only random-access iterator.
typedef base_type::attribute_type attribute_type
 The type of an attribute.

Public Member Functions

 binary_data_with_quark_base ()
 Constructs the object.
virtual ~binary_data_with_quark_base ()
 Destructs the object.
int num_attributes () const
 Returns the total number of attributes.
int num_labels () const
 Returns the total number of labels.
int num_features () const
 Returns the total number of features.

Data Fields

attributes_quark_type attributes
 A feature quark.


Member Function Documentation

template<class instance_tmpl, class attributes_quark_tmpl>
int classias::binary_data_with_quark_base< instance_tmpl, attributes_quark_tmpl >::num_attributes (  )  const [inline]

Returns the total number of attributes.

Returns:
int The total number of attributes.

Reimplemented from classias::binary_data_base< instance_tmpl >.

template<class instance_tmpl, class attributes_quark_tmpl>
int classias::binary_data_with_quark_base< instance_tmpl, attributes_quark_tmpl >::num_labels (  )  const [inline]

Returns the total number of labels.

Returns:
int The total number of labels. This is always 2 for the data collection for binary instances.

Reimplemented from classias::binary_data_base< instance_tmpl >.

template<class instance_tmpl, class attributes_quark_tmpl>
int classias::binary_data_with_quark_base< instance_tmpl, attributes_quark_tmpl >::num_features (  )  const [inline]

Returns the total number of features.

Returns:
int The total number of features.

Reimplemented from classias::binary_data_base< instance_tmpl >.


Copyright (c) 2002-2009 by Naoaki Okazaki
Mon Dec 28 23:41:04 2009