BitValues Struct Reference

Public interface of class 'BitValues'. More...

#include <BitValues.h>

Related Functions
(Note that these are not member functions.)
BitValues_ptr	BitValues_create (struct BoolEnc_TAG *enc, node_ptr var)
	The BitValues class constructor.
void	BitValues_destroy (BitValues_ptr self)
	The BitValues class destructor.
BitValue	BitValues_get (const BitValues_ptr self, size_t index)
	Gets the value of ith bit.
NodeList_ptr	BitValues_get_bits (const BitValues_ptr self)
	Returns the list of names of internal bits.
node_ptr	BitValues_get_scalar_var (const BitValues_ptr self)
	Returns the scalar variable self is a value for.
size_t	BitValues_get_size (const BitValues_ptr self)
	Returns the number of bits inside self.
BitValue	BitValues_get_value_from_expr (const BitValues_ptr self, node_ptr expr)
	Given a TRUE or FALSE expression, returns the corresponding BitValue.
void	BitValues_reset (BitValues_ptr self)
	Resets the values of bits to BIT_VALUE_DONTCARE.
void	BitValues_set (BitValues_ptr self, size_t index, BitValue val)
	Sets ith bit value to the given value.
void	BitValues_set_from_expr (BitValues_ptr self, size_t index, node_ptr expr)
	Sets ith bit value to the given value that is given as node_ptr.
void	BitValues_set_from_values_list (BitValues_ptr self, struct BoolEnc_TAG *enc, node_ptr vals)
	Given a list of assignments (IFF or EQUAL) to bits, sets values.

Detailed Description

Public interface of class 'BitValues'.

Author:: Roberto Cavada BitValues is a structured array of values of bits. bits are boolean variable that are used to encode a scalar variable. A BitValues is used when extracting scalar value of a variable from the assigments to its bits. A bit value can be BIT_VAL_TRUE, BIT_VAL_FALSE or BIT_VAL_DONTCARE

Definition of the public accessor for class BitValues

BitValues_ptr BitValues_create	(	struct BoolEnc_TAG *	enc,
		node_ptr	var
	)			`[related]`

The BitValues class constructor.

The BitValues class constructor

void BitValues_destroy ( BitValues_ptr self ) [related]

The BitValues class destructor.

The BitValues class destructor

Gets the value of ith bit.

NodeList_ptr BitValues_get_bits ( const BitValues_ptr self ) [related]

Returns the list of names of internal bits.

Returned list belongs to self, do not destroy or change it.

node_ptr BitValues_get_scalar_var ( const BitValues_ptr self ) [related]

Returns the scalar variable self is a value for.

size_t BitValues_get_size ( const BitValues_ptr self ) [related]

Returns the number of bits inside self.

BitValue BitValues_get_value_from_expr	(	const BitValues_ptr	self,
		node_ptr	expr
	)			`[related]`

Given a TRUE or FALSE expression, returns the corresponding BitValue.

void BitValues_reset ( BitValues_ptr self ) [related]

Resets the values of bits to BIT_VALUE_DONTCARE.

Sets ith bit value to the given value.

Sets ith bit value to the given value that is given as node_ptr.

expr can be either TRUE or FALSE

void BitValues_set_from_values_list	(	BitValues_ptr	self,
		struct BoolEnc_TAG *	enc,
		node_ptr	vals
	)			`[related]`

Given a list of assignments (IFF or EQUAL) to bits, sets values.

The list can be partial, unspecified values are set to BIT_VALUE_DONCARE

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