#include <IceContainer.h>

Inheritance diagram for Container:

[legend]

Public Member Functions
inline_ Container &	Add (udword entry)

inline_ Container &	Add (const udword *entries, udword nb)

inline_ Container &	Add (float entry)

inline_ Container &	Add (const float *entries, udword nb)

inline_ Container &	AddUnique (udword entry)
	Add unique [slow]. More...

	Container ()

	Container (const Container &object)

	Container (udword size, float growth_factor)

bool	Contains (udword entry, udword *location=null) const

bool	Delete (udword entry)

inline_ void	DeleteIndex (udword index)
	Deletes the entry whose index is given. More...

bool	DeleteKeepingOrder (udword entry)

inline_ void	DeleteLastEntry ()
	Deletes the very last entry. More...

Container &	Empty ()

Container &	FindNext (udword &entry, FindMode find_mode=FIND_CLAMP)

Container &	FindPrev (udword &entry, FindMode find_mode=FIND_CLAMP)

inline_ void	ForceSize (udword size)

inline_ udword *	GetEntries () const
	Returns the list of entries. More...

inline_ udword	GetEntry (udword i) const
	Returns ith entry. More...

inline_ udword	GetFirst () const

inline_ float	GetGrowthFactor () const
	Returns the growth factor. More...

inline_ udword	GetLast () const

inline_ udword	GetNbContainers () const
	Operator for "Container A = Container B". More...

inline_ udword	GetNbEntries () const
	Returns the current number of entries. More...

inline_ udword	GetTotalBytes () const

udword	GetUsedRam () const

inline_ bool	IsFull () const
	Checks the container is full. More...

inline_ BOOL	IsNotEmpty () const
	Checks the container is empty. More...

inline_ udword	operator[] (udword i) const
	Read-access as an array. More...

inline_ udword &	operator[] (udword i)
	Write-access as an array. More...

bool	Refit ()

inline_ void	Reset ()

inline_ void	SetGrowthFactor (float growth)
	Sets the growth factor. More...

bool	SetSize (udword nb)

	~Container ()

Private Member Functions
bool	Resize (udword needed=1)

Private Attributes
udword	mCurNbEntries
	Current number of entries. More...

udword *	mEntries
	List of entries. More...

float	mGrowthFactor
	Resize: new number of entries = old number * mGrowthFactor. More...

udword	mMaxNbEntries
	Maximum possible number of entries. More...

Static Private Attributes
static udword	mNbContainers
	Number of containers around. More...

static udword	mUsedRam
	Amount of bytes used by containers in the system. More...

Detailed Description

Contains a list of 32-bits values. Use this class when you need to store an unknown number of values. The list is automatically resized and can contains 32-bits entities (dwords or floats)

Author: Pierre Terdiman

Version: 1.0

Date: 08.15.98

Definition at line 25 of file IceContainer.h.

Constructor & Destructor Documentation

◆ Container() [1/3]

Container::Container ( )

◆ Container() [2/3]

Container::Container ( const Container & object )

◆ Container() [3/3]

Container::Container	(	udword	size,
		float	growth_factor
	)

◆ ~Container()

Container::~Container ( )

Member Function Documentation

◆ Add() [1/4]

inline_ Container& Container::Add ( udword entry )

inline

A O(1) method to add a value in the container. The container is automatically resized if needed. The method is inline, not the resize. The call overhead happens on resizes only, which is not a problem since the resizing operation costs a lot more than the call overhead...

Parameters

entry [in] a udword to store in the container

See also: Add(float entry); Empty(); Contains(udword entry)

Returns: Self-Reference

Definition at line 47 of file IceContainer.h.

◆ Add() [2/4]

inline_ Container& Container::Add	(	const udword *	entries,
		udword	nb
	)

inline

Definition at line 57 of file IceContainer.h.

◆ Add() [3/4]

inline_ Container& Container::Add ( float entry )

inline

A O(1) method to add a value in the container. The container is automatically resized if needed. The method is inline, not the resize. The call overhead happens on resizes only, which is not a problem since the resizing operation costs a lot more than the call overhead...

Parameters

entry [in] a float to store in the container

See also: Add(udword entry); Empty(); Contains(udword entry)

Returns: Self-Reference

Definition at line 81 of file IceContainer.h.

◆ Add() [4/4]

inline_ Container& Container::Add	(	const float *	entries,
		udword	nb
	)

inline

Definition at line 91 of file IceContainer.h.

◆ AddUnique()

inline_ Container& Container::AddUnique ( udword entry )

inline

Add unique [slow].

Definition at line 103 of file IceContainer.h.

◆ Contains()

bool Container::Contains	(	udword	entry,
		udword *	location = `null`
	)		const

◆ Delete()

bool Container::Delete ( udword entry )

◆ DeleteIndex()

inline_ void Container::DeleteIndex ( udword index )

inline

Deletes the entry whose index is given.

Definition at line 164 of file IceContainer.h.

◆ DeleteKeepingOrder()

bool Container::DeleteKeepingOrder ( udword entry )

◆ DeleteLastEntry()

inline_ void Container::DeleteLastEntry ( )

inline

Deletes the very last entry.

Definition at line 162 of file IceContainer.h.

◆ Empty()

Container& Container::Empty ( )

Clears the container. All stored values are deleted, and it frees used ram.

See also: Reset()

Returns: Self-Reference

◆ FindNext()

Container& Container::FindNext	(	udword &	entry,
		FindMode	find_mode = `FIND_CLAMP`
	)

◆ FindPrev()

Container& Container::FindPrev	(	udword &	entry,
		FindMode	find_mode = `FIND_CLAMP`
	)

◆ ForceSize()

inline_ void Container::ForceSize ( udword size )

inline

Definition at line 133 of file IceContainer.h.

◆ GetEntries()

inline_ udword* Container::GetEntries ( ) const

inline

Returns the list of entries.

Definition at line 172 of file IceContainer.h.

◆ GetEntry()

inline_ udword Container::GetEntry ( udword i ) const

inline

Returns ith entry.

Definition at line 171 of file IceContainer.h.

◆ GetFirst()

inline_ udword Container::GetFirst ( ) const

inline

Definition at line 174 of file IceContainer.h.

◆ GetGrowthFactor()

inline_ float Container::GetGrowthFactor ( ) const

inline

Returns the growth factor.

Definition at line 178 of file IceContainer.h.

◆ GetLast()

inline_ udword Container::GetLast ( ) const

inline

Definition at line 175 of file IceContainer.h.

◆ GetNbContainers()

inline_ udword Container::GetNbContainers ( ) const

inline

Operator for "Container A = Container B".

Definition at line 195 of file IceContainer.h.

◆ GetNbEntries()

inline_ udword Container::GetNbEntries ( ) const

inline

Returns the current number of entries.

Definition at line 170 of file IceContainer.h.

◆ GetTotalBytes()

inline_ udword Container::GetTotalBytes ( ) const

inline

Definition at line 196 of file IceContainer.h.

◆ GetUsedRam()

udword Container::GetUsedRam ( ) const

◆ IsFull()

inline_ bool Container::IsFull ( ) const

inline

Checks the container is full.

Definition at line 180 of file IceContainer.h.

◆ IsNotEmpty()

inline_ BOOL Container::IsNotEmpty ( ) const

inline

Checks the container is empty.

Definition at line 181 of file IceContainer.h.

◆ operator[]() [1/2]

inline_ udword Container::operator[] ( udword i ) const

inline

Read-access as an array.

Definition at line 184 of file IceContainer.h.

◆ operator[]() [2/2]

inline_ udword& Container::operator[] ( udword i )

inline

Write-access as an array.

Definition at line 186 of file IceContainer.h.

◆ Refit()

bool Container::Refit ( )

Refits the container and get rid of unused bytes.

Returns: true if success

◆ Reset()

inline_ void Container::Reset ( )

inline

Resets the container. Stored values are discarded but the buffer is kept so that further calls don't need resizing again. That's a kind of temporal coherence.

See also: Empty()

Definition at line 125 of file IceContainer.h.

◆ Resize()

bool Container::Resize ( udword needed = 1 )

private

◆ SetGrowthFactor()

inline_ void Container::SetGrowthFactor ( float growth )

inline

Sets the growth factor.

Definition at line 179 of file IceContainer.h.

◆ SetSize()

bool Container::SetSize ( udword nb )

Sets the initial size of the container. If it already contains something, it's discarded.

Parameters

nb	[in] Number of entries

Returns: true if success

Member Data Documentation

◆ mCurNbEntries

udword Container::mCurNbEntries

private

Current number of entries.

Definition at line 207 of file IceContainer.h.

◆ mEntries

udword* Container::mEntries

private

List of entries.

Definition at line 208 of file IceContainer.h.

◆ mGrowthFactor

float Container::mGrowthFactor

private

Resize: new number of entries = old number * mGrowthFactor.

Definition at line 209 of file IceContainer.h.

◆ mMaxNbEntries

udword Container::mMaxNbEntries

private

Maximum possible number of entries.

Definition at line 206 of file IceContainer.h.

◆ mNbContainers

udword Container::mNbContainers

staticprivate

Number of containers around.

Definition at line 199 of file IceContainer.h.

◆ mUsedRam

udword Container::mUsedRam

staticprivate

Amount of bytes used by containers in the system.

Definition at line 200 of file IceContainer.h.

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

IceContainer.h

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Container() [1/3]

◆ Container() [2/3]

◆ Container() [3/3]

◆ ~Container()

Member Function Documentation

◆ Add() [1/4]

◆ Add() [2/4]

◆ Add() [3/4]

◆ Add() [4/4]

◆ AddUnique()

◆ Contains()

◆ Delete()

◆ DeleteIndex()

◆ DeleteKeepingOrder()

◆ DeleteLastEntry()

◆ Empty()

◆ FindNext()

◆ FindPrev()

◆ ForceSize()

◆ GetEntries()

◆ GetEntry()

◆ GetFirst()

◆ GetGrowthFactor()

◆ GetLast()

◆ GetNbContainers()

◆ GetNbEntries()

◆ GetTotalBytes()

◆ GetUsedRam()

◆ IsFull()

◆ IsNotEmpty()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ Refit()

◆ Reset()

◆ Resize()

◆ SetGrowthFactor()

◆ SetSize()

Member Data Documentation

◆ mCurNbEntries

◆ mEntries

◆ mGrowthFactor

◆ mMaxNbEntries

◆ mNbContainers

◆ mUsedRam