BiMap Struct Reference

Definition of the public accessor for class BiMap. More...

#include <BiMap.h>

Related Functions
(Note that these are not member functions.)
void	BiMap_clear (BiMap_ptr self)
NodeList_ptr	BiMap_codomain (BiMap_ptr self)
	Returns the codomain as a list.
boolean	BiMap_codomain_contains (BiMap_ptr self, node_ptr codomain_element)
	Returns true if the given codomain element is mapped from any value, false otherwise.
BiMap_ptr	BiMap_create (void)
	The BiMap class constructor.
void	BiMap_destroy (BiMap_ptr self)
	The BiMap class destructor.
NodeList_ptr	BiMap_domain (BiMap_ptr self)
	Returns the domain as a list.
boolean	BiMap_domain_contains (BiMap_ptr self, node_ptr domain_element)
	Returns true if the given domain element is mapped to any value, false otherwise.
void	BiMap_gen_iter (BiMap_ptr self, BiMapIter *iter)
	Generate a new iter.
node_ptr	BiMap_get (BiMap_ptr self, node_ptr domain_element)
	Return the codomain value for the given domain element.
node_ptr	BiMap_inverse_get (BiMap_ptr self, node_ptr codomain_element)
	Return the domain value that maps to the given codomain element.
hash_ptr	BiMap_inverse_map (BiMap_ptr self)
	Returns the inverse map as hash.
boolean	BiMap_is_empty (BiMap_ptr self)
	BiMap.is_empty.
node_ptr	BiMap_iter_get_codomain_element (BiMap_ptr self, BiMapIter *iter)
	Returns the number of element to element mappings.
node_ptr	BiMap_iter_get_domain_element (BiMap_ptr self, BiMapIter *iter)
	Returns the number of element to element mappings.
boolean	BiMap_iter_is_end (BiMap_ptr self, BiMapIter *iter)
	Returns true if the iteration is ended.
void	BiMap_iter_next (BiMap_ptr self, BiMapIter *iter)
	Sets the iterator to the next element.
hash_ptr	BiMap_map (BiMap_ptr self)
	Returns the map as hash.
void	BiMap_put (BiMap_ptr self, node_ptr domain_element, node_ptr codomain_element)
	Put a new mapping.
unsigned	BiMap_size (BiMap_ptr self)
	Returns the number of element to element mappings.

---

Detailed Description

Definition of the public accessor for class BiMap.

---

Friends And Related Function Documentation

void BiMap_clear

(

BiMap_ptr

self

)

[related]

NodeList_ptr BiMap_codomain

(

BiMap_ptr

self

)

[related]

Returns the codomain as a list.

The order is preserved according to the domain_as_list. The returned list owns to the BiMap and should not be modified. Modifications can compromise the consistency of the map.

See also:

domain

boolean BiMap_codomain_contains	(	BiMap_ptr	self,
		node_ptr	codomain_element
	)			[related]

Returns true if the given codomain element is mapped from any value, false otherwise.

BiMap_ptr BiMap_create

(

void

)

[related]

The BiMap class constructor.

The BiMap class constructor

See also:

BiMap_destroy

void BiMap_destroy

(

BiMap_ptr

self

)

[related]

The BiMap class destructor.

The BiMap class destructor

See also:

BiMap_create

NodeList_ptr BiMap_domain

(

BiMap_ptr

self

)

[related]

Returns the domain as a list.

The order is preserved according to the codomain_as_list. The returned list owns to the BiMap and should not be modified. Modifications can compromise the consistency of the map.

See also:

codomain

boolean BiMap_domain_contains	(	BiMap_ptr	self,
		node_ptr	domain_element
	)			[related]

Returns true if the given domain element is mapped to any value, false otherwise.

void BiMap_gen_iter	(	BiMap_ptr	self,
		BiMapIter *	iter
	)			[related]

Generate a new iter.

node_ptr BiMap_get	(	BiMap_ptr	self,
		node_ptr	domain_element
	)			[related]

Return the codomain value for the given domain element.

It assumes the mapping exists

node_ptr BiMap_inverse_get	(	BiMap_ptr	self,
		node_ptr	codomain_element
	)			[related]

Return the domain value that maps to the given codomain element.

It assumes the mapping exists

hash_ptr BiMap_inverse_map

(

BiMap_ptr

self

)

[related]

Returns the inverse map as hash.

The returned hash owns to the BiMap and should not be modified. Modifications can compromise the consistency of the map.

See also:

map

boolean BiMap_is_empty

(

BiMap_ptr

self

)

[related]

BiMap.is_empty.

It returns true iff the map does not contain any element

node_ptr BiMap_iter_get_codomain_element	(	BiMap_ptr	self,
		BiMapIter *	iter
	)			[related]

Returns the number of element to element mappings.

node_ptr BiMap_iter_get_domain_element	(	BiMap_ptr	self,
		BiMapIter *	iter
	)			[related]

Returns the number of element to element mappings.

boolean BiMap_iter_is_end	(	BiMap_ptr	self,
		BiMapIter *	iter
	)			[related]

Returns true if the iteration is ended.

void BiMap_iter_next	(	BiMap_ptr	self,
		BiMapIter *	iter
	)			[related]

Sets the iterator to the next element.

hash_ptr BiMap_map

(

BiMap_ptr

self

)

[related]

Returns the map as hash.

The returned hash owns to the BiMap and should not be modified. Modifications can compromise the consistency of the map.

See also:

inverse_map

void BiMap_put	(	BiMap_ptr	self,
		node_ptr	domain_element,
		node_ptr	codomain_element
	)			[related]

Put a new mapping.

It inserts a new domain_element - codomain_element mapping. It does not allow overwriting of previous elements in the respective domains.

unsigned BiMap_size

(

BiMap_ptr

self

)

[related]

Returns the number of element to element mappings.

---

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

• NuSMV/code/nusmv/core/utils/BiMap.h