A Keyspace captures all the elements that are present in the datasets passed to an algorithm. More...

#include <Keyspace.h>

Public Member Functions
	Keyspace ()

	Keyspace (const Keyspace &keyspace)

	Keyspace (const std::set< KeyspaceDimension > &dims)

std::set< DataKeyDimension >	getDimensions () const

size_t	getDimensionCount () const

bool	hasDimension (const DataKeyDimension &dim) const

bool	includesKey (const DataKey &key) const
	Returns true if all the dimensions in the key are part of this keyspace. More...

void	validateKey (const DataKey &key) const
	Throws exception if includesKey() is false. More...

KeyspaceDimension	getKeyspaceDimension (const DataKeyDimension &dim) const

std::string	str () const

	~Keyspace ()

Keyspace &	operator= (const Keyspace &keyspace)

bool	operator== (const Keyspace &keyspace) const

bool	operator!= (const Keyspace &keyspace) const

bool	operator< (const Keyspace &keyspace) const

Detailed Description

A Keyspace captures all the elements that are present in the datasets passed to an algorithm.

Instances are immutable.

Constructor & Destructor Documentation

BUSBOY::Keyspace::Keyspace ( )

BUSBOY::Keyspace::Keyspace ( const Keyspace & keyspace )

BUSBOY::Keyspace::Keyspace ( const std::set< KeyspaceDimension > & dims )

BUSBOY::Keyspace::~Keyspace ( )

size_t BUSBOY::Keyspace::getDimensionCount ( ) const

std::set< DataKeyDimension > BUSBOY::Keyspace::getDimensions ( ) const

KeyspaceDimension BUSBOY::Keyspace::getKeyspaceDimension ( const DataKeyDimension & dim ) const

bool BUSBOY::Keyspace::hasDimension ( const DataKeyDimension & dim ) const

bool BUSBOY::Keyspace::includesKey ( const DataKey & key ) const

Returns true if all the dimensions in the key are part of this keyspace.

Note that this is indepdent of whether this was one of the keys the keyspace was derived from.

bool BUSBOY::Keyspace::operator!= ( const Keyspace & keyspace ) const

bool BUSBOY::Keyspace::operator< ( const Keyspace & keyspace ) const

Keyspace & BUSBOY::Keyspace::operator= ( const Keyspace & keyspace )

bool BUSBOY::Keyspace::operator== ( const Keyspace & keyspace ) const

std::string BUSBOY::Keyspace::str ( ) const

void BUSBOY::Keyspace::validateKey ( const DataKey & key ) const

Throws exception if includesKey() is false.

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