A dynamic set object. More...

Files
file	vset.h
	Class Vset: a dynamic set object.

Classes
struct	sVset
	Contains public data members for Vset class. More...

Typedefs
typedef struct sVset	Vset
	Declaration of the Vset class as the Vset structure.

Functions
int	Vset_num (Vset *thee)
	Return the number of things currently in the list.
char *	Vset_access (Vset *thee, int i)
	Access an object in an arbitrary place in the list.
char *	Vset_create (Vset *thee)
	Create an object on the end of the list.
char *	Vset_first (Vset *thee)
	Return the first object in the set.
char *	Vset_last (Vset *thee)
	Return the last object in the set.
char *	Vset_next (Vset *thee)
	Return the next object in the set.
char *	Vset_prev (Vset *thee)
	Return the prev object in the set.
char *	Vset_peekFirst (Vset *thee)
	Return the first object in the set.
char *	Vset_peekLast (Vset *thee)
	Return the last object in the set.
void	Vset_destroy (Vset *thee)
	Delete an object from the end of the list.
Vset *	Vset_ctor (Vmem vmem, const char tname, int tsize, int tmaxNum, int ioKey)
	Construct the set object.
void	Vset_dtor (Vset **thee)
	Destroy the set object.
char *	Vset_createLast (Vset *thee)
	Create an object on the end of the list.
void	Vset_destroyLast (Vset *thee)
	Free up the object currently on the end of the list.
void	Vset_initData (Vset *thee)
	Initialize the Vset data (thee).
void	Vset_reset (Vset *thee)
	Release all Ram controlled by this (thee) and re-initialize.
void	Vset_check (Vset thee, int tnum, int tsize, int tVecUse, int tVecMal, int tVecOhd)
	Get and return the RAM Control Block (thee) information.
void	Vset_memChk (Vset *thee)
	Print the exact current malloc usage.

Detailed Description

A dynamic set object.

Typedef Documentation

◆ Vset

typedef struct sVset Vset

Declaration of the Vset class as the Vset structure.

Author: Michael Holst

Function Documentation

◆ Vset_access()

char * Vset_access	(	Vset *	thee,
		int	i )

Access an object in an arbitrary place in the list.

Author: Michael Holst

Note: Class Vset: Inlineable method (vset.c)

Returns: list of pointers to blocks of storage we manage

Parameters

thee	Pointer to the Vset object
i	index of the object

References Vset_access().

Referenced by Vset_access().

Here is the call graph for this function:

◆ Vset_check()

void Vset_check	(	Vset *	thee,
		int *	tnum,
		int *	tsize,
		int *	tVecUse,
		int *	tVecMal,
		int *	tVecOhd )

Get and return the RAM Control Block (thee) information.

Author: Michael Holst

Note: Class Vset: Non-Inlineable method (vset.c)

Returns: None

Parameters

thee	Pointer to the Vset object
tnum	the global "T" counter – how many "T"s in list
tsize	size of the object in bytes
tVecUse	size of the total objects
tVecMal	size of the total RAM Control Block
tVecOhd	maximal size of RAM Control Block

References Vset_check().

Referenced by Vset_check().

Here is the call graph for this function:

◆ Vset_create()

char * Vset_create ( Vset * thee )

Create an object on the end of the list.

Author: Michael Holst

Note: Class Vset: Inlineable method (vset.c)

Returns: Pointer to a created Vset object on the end of the list

Parameters

thee	Pointer to the Vset object

References Vset_create().

Referenced by Vset_create().

Here is the call graph for this function:

◆ Vset_createLast()

char * Vset_createLast ( Vset * thee )

Create an object on the end of the list.

Author: Michael Holst

Note: Class Vset: Non-Inlineable method (vset.c)

Returns: Pointer to the created Vset object

Parameters

thee	Pointer to the Vset object

References Vset_createLast().

Referenced by Vset_createLast().

Here is the call graph for this function:

◆ Vset_ctor()

Vset * Vset_ctor	(	Vmem *	vmem,
		const char *	tname,
		int	tsize,
		int	tmaxNum,
		int	ioKey )

Construct the set object.

Author: Michael Holst

Note: Class Vset: Non-Inlineable method (vset.c)

Returns: Pointer to a new allocated Vset object

Parameters

vmem	Memory management object
tname	name of object we are managing
tsize	size of the object in bytes
tmaxNum	number of objects to manage (user specified)
ioKey	index for i/o

References Vset_ctor().

Referenced by Vset_ctor().

Here is the call graph for this function:

◆ Vset_destroy()

void Vset_destroy ( Vset * thee )

Delete an object from the end of the list.

Author: Michael Holst

Note: Class Vset: Inlineable method (vset.c)

Returns: None

Parameters

thee	Pointer to the Vset object

References Vset_destroy().

Referenced by Vset_destroy().

Here is the call graph for this function:

◆ Vset_destroyLast()

void Vset_destroyLast ( Vset * thee )

Free up the object currently on the end of the list.

Author: Michael Holst

Note: Class Vset: Non-Inlineable method (vset.c)

Returns: None

Parameters

thee	Pointer to the Vset object

References Vset_destroyLast().

Referenced by Vset_destroyLast().

Here is the call graph for this function:

◆ Vset_dtor()

void Vset_dtor ( Vset ** thee )

Destroy the set object.

Author: Michael Holst

Note: Class Vset: Non-Inlineable method (vset.c)

Returns: None

Parameters

thee	Pointer to the Vset object

References Vset_dtor().

Referenced by Vset_dtor().

Here is the call graph for this function:

◆ Vset_first()

char * Vset_first ( Vset * thee )

Return the first object in the set.

Author: Michael Holst

Note: Class Vset: Inlineable method (vset.c)

Returns: the first object in the set

Parameters

thee	Pointer to the Vset object

References Vset_first().

Referenced by Vset_first().

Here is the call graph for this function:

◆ Vset_initData()

void Vset_initData ( Vset * thee )

Initialize the Vset data (thee).

Author: Michael Holst

Note: Class Vset: Non-Inlineable method (vset.c)

Returns: None

Parameters

thee	Pointer to the Vset object

References Vset_initData().

Referenced by Vset_initData().

Here is the call graph for this function:

◆ Vset_last()

char * Vset_last ( Vset * thee )

Return the last object in the set.

Author: Michael Holst

Note: Class Vset: Inlineable method (vset.c)

Returns: the last object in the set.

Parameters

thee	Pointer to the Vset object

References Vset_last().

Referenced by Vset_last().

Here is the call graph for this function:

◆ Vset_memChk()

void Vset_memChk ( Vset * thee )

Print the exact current malloc usage.

Author: Michael Holst

Note: Class Vset: Non-Inlineable method (vset.c)

Returns: None

Parameters

thee	Pointer to the Vset object

References Vset_memChk().

Referenced by Vset_memChk().

Here is the call graph for this function:

◆ Vset_next()

char * Vset_next ( Vset * thee )

Return the next object in the set.

Author: Michael Holst

Note: Class Vset: Inlineable method (vset.c)

Returns: the next object in the set.

Parameters

thee	Pointer to the Vset object

References Vset_next().

Referenced by Vset_next().

Here is the call graph for this function:

◆ Vset_num()

int Vset_num ( Vset * thee )

Return the number of things currently in the list.

Author: Michael Holst

Note: Class Vset: Inlineable method (vset.c)

Returns: the number of things currently in the list.

Parameters

thee	Pointer to the Vset object

References Vset_num().

Referenced by Vset_num().

Here is the call graph for this function:

◆ Vset_peekFirst()

char * Vset_peekFirst ( Vset * thee )

Return the first object in the set.

Author: Michael Holst

Note: Class Vset: Inlineable method (vset.c)

Returns: the first object in the set

Parameters

thee	Pointer to the Vset object

References Vset_peekFirst().

Referenced by Vset_peekFirst().

Here is the call graph for this function:

◆ Vset_peekLast()

char * Vset_peekLast ( Vset * thee )

Return the last object in the set.

Author: Michael Holst

Note: Class Vset: Inlineable method (vset.c)

Returns: the last object in the set.

Parameters

thee	Pointer to the Vset object

References Vset_peekLast().

Referenced by Vset_peekLast().

Here is the call graph for this function:

◆ Vset_prev()

char * Vset_prev ( Vset * thee )

Return the prev object in the set.

Author: Michael Holst

Note: Class Vset: Inlineable method (vset.c)

Returns: the prev object in the set

Parameters

thee	Pointer to the Vset object

References Vset_prev().

Referenced by Vset_prev().

Here is the call graph for this function:

◆ Vset_reset()

void Vset_reset ( Vset * thee )

Release all Ram controlled by this (thee) and re-initialize.

Author: Michael Holst

Note: Class Vset: Non-Inlineable method (vset.c)

Returns: None

Parameters

thee	Pointer to the Vset object

References Vset_reset().

Referenced by Vset_reset().

Here is the call graph for this function:

Files

Classes

Typedefs

Functions

Detailed Description

Typedef Documentation

◆ Vset

Function Documentation

◆ Vset_access()

◆ Vset_check()

◆ Vset_create()

◆ Vset_createLast()

◆ Vset_ctor()

◆ Vset_destroy()

◆ Vset_destroyLast()

◆ Vset_dtor()

◆ Vset_first()

◆ Vset_initData()

◆ Vset_last()

◆ Vset_memChk()

◆ Vset_next()

◆ Vset_num()

◆ Vset_peekFirst()

◆ Vset_peekLast()

◆ Vset_prev()

◆ Vset_reset()