SHOGUN  5.0.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules
List of all members | Public Member Functions | Friends
BaseTag Class Reference

Detailed Description

Base class for all tags. This class stores name and not the type information for a shogun object. It can be used as an identifier for a shogun object where type information is not known. One application of this can be found in CSGObject::set_param_with_btag().

Definition at line 48 of file basetag.h.

Inheritance diagram for BaseTag:
[legend]

Public Member Functions

 BaseTag (const std::string &_name)
 
 BaseTag (const BaseTag &other)
 
BaseTagoperator= (const BaseTag &other)
 
std::string name () const
 
std::size_t hash () const
 

Friends

bool operator== (const BaseTag &first, const BaseTag &second)
 
bool operator!= (const BaseTag &first, const BaseTag &second)
 
bool operator< (const BaseTag &first, const BaseTag &second)
 

Constructor & Destructor Documentation

BaseTag ( const std::string &  _name)
explicit

Constructor to initialize hash from name

Parameters
_namename for tag

Definition at line 55 of file basetag.h.

BaseTag ( const BaseTag other)

Copy constructor

Parameters
otherbasetag object to be copied

Definition at line 63 of file basetag.h.

Member Function Documentation

std::size_t hash ( ) const
Returns
hash of Tag

Definition at line 85 of file basetag.h.

std::string name ( ) const
Returns
name of Tag

Definition at line 79 of file basetag.h.

BaseTag& operator= ( const BaseTag other)

Class Assignment operator

Parameters
otherbasetag object to be assigned

Definition at line 71 of file basetag.h.

Friends And Related Function Documentation

bool operator!= ( const BaseTag first,
const BaseTag second 
)
friend

Inequality operator

Parameters
firstfirst BaseTag
secondsecondBaseTag

Definition at line 120 of file basetag.h.

bool operator< ( const BaseTag first,
const BaseTag second 
)
friend

Comparison operator

Parameters
firstfirst BaseTag
secondsecondBaseTag

Definition at line 125 of file basetag.h.

bool operator== ( const BaseTag first,
const BaseTag second 
)
friend

Equality operator

Parameters
firstfirst BaseTag
secondsecondBaseTag

Definition at line 115 of file basetag.h.


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

SHOGUN Machine Learning Toolbox - Documentation