Frequency Class Reference

Frequency: a plain-old-data type representing a character and its frequency. More...

#include <frequency.h>

Public Member Functions
	Frequency (char character, int frequency)
	Constructs a new Frequency object from a given character and its associated frequency in a file. More...
	Frequency (int frequency)
	Constructs a new Frequency object from a given frequency count. More...
char	getCharacter () const
	Getter for the character for this Frequency object. More...
int	getFrequency () const
	Getter for the frequency for this Frequency object. More...
bool	operator< (const Frequency &other) const
	Comparison operator for Frequency objects. More...
bool	operator== (const Frequency &other) const
	Comparison operator for Frequency objects. More...

Private Attributes
char	character_
int	frequency_

Detailed Description

Frequency: a plain-old-data type representing a character and its frequency.

Used by the HuffmanTree as the data element of the TreeNodes. If a node is an internal node, the character is the null character ('\0').

Constructor & Destructor Documentation

Frequency() [1/2]

Frequency::Frequency	(	char	character,
		int	frequency
	)

Constructs a new Frequency object from a given character and its associated frequency in a file.

Parameters

character	The character this Frequency represents.
frequency	The number of times this character appears in the file.

Frequency() [2/2]

Frequency::Frequency

(

int

frequency

)

Constructs a new Frequency object from a given frequency count.

Frequencies created this way have the null character ('\0') as their character data (these kinds of Frequency objects are used as the data of internal nodes in the HuffmanTree).

Parameters

frequency

The number to be stored.

Member Function Documentation

getCharacter()

char Frequency::getCharacter

(

)

const

Getter for the character for this Frequency object.

Returns

The character for this Frequency.

getFrequency()

int Frequency::getFrequency

(

)

const

Getter for the frequency for this Frequency object.

Returns

The frequency member of this object.

operator<()

bool Frequency::operator<

(

const Frequency &

other

)

const

Comparison operator for Frequency objects.

Allows for sorting with std::sort.

Parameters

other

The Frequency object to compare against.

Returns

Whether the current frequency is less than the given frequency (other).

operator==()

bool Frequency::operator==

(

const Frequency &

other

)

const

Comparison operator for Frequency objects.

Allows for determining whether the Frequency is the same as another.

Parameters

other

The Frequency object to compare against.

Returns

Whether the current Frequency is the same as the given Frequency (other).

---

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

• frequency.h
• frequency.cpp