Specialized bundling of boolean values as a vector of 3 components, element access using x(), y() and z() member functions. It also has some methods similar to bitSet. More...

Inheritance diagram for boolVector:

[legend]

Collaboration diagram for boolVector:

[legend]

Public Types
enum	components { X, Y, Z }
	Component labeling enumeration. More...

Public Types inherited from FixedList< bool, 3 >
typedef bool	value_type
	The value type the FixedList contains. More...

typedef bool *	pointer
	The pointer type for non-const access to value_type items. More...

typedef bool &	reference
	The type used for storing into value_type objects. More...

typedef bool *	iterator
	Random access iterator for traversing FixedList. More...

typedef label	size_type
	The type to represent the size of a FixedList. More...

typedef label	difference_type
	The difference between iterator objects. More...

typedef std::reverse_iterator< iterator >	reverse_iterator
	Reverse iterator (non-const access) More...

typedef std::reverse_iterator< const_iterator >	const_reverse_iterator
	Reverse iterator (const access) More...

Public Member Functions
	boolVector (const boolVector &)=default
	Copy construct. More...

boolVector &	operator= (const boolVector &)=default
	Copy assignment. More...

	boolVector (boolVector &&)=default
	Move construct. More...

boolVector &	operator= (boolVector &&)=default
	Move assignment. More...

	boolVector ()
	Default construct, zero-initialized (ie, false) More...

	boolVector (const bool val)
	Uniform construct with specified value. More...

	boolVector (const bool vx, const bool vy, const bool vz)
	Construct from three components. More...

	boolVector (Istream &is)
	Construct from Istream. More...

bool	all () const
	True if all components are set. More...

bool	any () const
	True if any components are set. More...

bool	none () const
	True if no components are set. More...

unsigned int	count (const bool on=true) const
	Count number of items set. More...

bool	x () const
	The x component. More...

bool	y () const
	The y component. More...

bool	z () const
	The z component. More...

bool &	x ()
	The x component. More...

bool &	y ()
	The y component. More...

bool &	z ()
	The z component. More...

void	flip ()
	Invert all values. More...

void	operator= (const bool value)
	Assignment of all entries to the given value. More...

Public Member Functions inherited from FixedList< bool, 3 >
void	writeEntry (const word &keyword, Ostream &os) const
	Write the list as a dictionary entry with keyword. More...

	FixedList ()=default
	Default construct. More...

	FixedList (const bool &val)
	Construct and initialize all entries to given value. More...

	FixedList (const zero)
	Construct and initialize all entries to zero. More...

	FixedList (const bool list[N])
	Copy construct from C-array. More...

	FixedList (const FixedList< bool, N > &list)
	Copy construct. More...

	FixedList (FixedList< bool, N > &&list)

	FixedList (InputIterator begIter, InputIterator endIter)
	Construct given begin/end iterators. More...

	FixedList (std::initializer_list< bool > list)
	Construct from an initializer list. More...

	FixedList (const UList< bool > &list)
	Construct from UList. More...

	FixedList (const UList< bool > &list, const FixedList< label, N > &indices)
	Copy construct from a subset of the input. More...

	FixedList (const SLList< bool > &list)
	Construct from SLList. More...

	FixedList (Istream &is)
	Construct from Istream. More...

autoPtr< FixedList< bool, N > >	clone () const
	Clone. More...

const bool *	cdata () const noexcept
	Return a const pointer to the first data element. More...

bool *	data () noexcept
	Return a pointer to the first data element. More...

bool &	first () noexcept
	The first element of the list, position [0]. More...

const bool &	first () const noexcept
	The first element of the list, position [0]. More...

bool &	last () noexcept
	The last element of the list, position [N-1]. More...

const bool &	last () const noexcept
	The last element of the list, position [N-1]. More...

label	fcIndex (const label i) const

const bool &	fcValue (const label i) const
	Return forward circular value (ie, next value in the list) More...

bool &	fcValue (const label i)
	Return forward circular value (ie, next value in the list) More...

label	rcIndex (const label i) const

const bool &	rcValue (const label i) const
	Return reverse circular value (ie, previous value in the list) More...

bool &	rcValue (const label i)
	Return reverse circular value (ie, previous value in the list) More...

void	checkStart (const label start) const
	Check start is within valid range [0,size) More...

void	checkSize (const label size) const
	Check size is identical to template parameter N. More...

void	checkIndex (const label i) const
	Check index is within valid range [0,N) More...

bool	uniform () const
	True if all entries have identical values, and list is non-empty. More...

label	find (const bool &val, label pos=0) const
	Find index of the first occurrence of the value. More...

label	rfind (const bool &val, label pos=-1) const
	Find index of the last occurrence of the value. More...

bool	found (const bool &val, label pos=0) const
	True if the value if found in the list. More...

void	resize (const label n)
	Dummy resize function, to make FixedList consistent with List. More...

void	setSize (const label n)
	Dummy setSize function, to make FixedList consistent with List. More...

void	moveFirst (const label i)
	Move element to the first position. More...

void	moveLast (const label i)
	Move element to the last position. More...

void	swapFirst (const label i)
	Swap element with the first element. More...

void	swapLast (const label i)
	Swap element with the last element. More...

void	transfer (FixedList< bool, N > &list)

bool &	operator[] (const label i)
	Return element of FixedList. More...

const bool &	operator[] (const label i) const
	Return element of constant FixedList. More...

void	operator= (const bool list[N])
	Assignment to array operator. Takes linear time. More...

void	operator= (const UList< bool > &list)
	Assignment to UList operator. Takes linear time. More...

void	operator= (const SLList< bool > &list)
	Assignment to SLList operator. Takes linear time. More...

void	operator= (std::initializer_list< bool > list)
	Assignment to an initializer list. Takes linear time. More...

void	operator= (const bool &val)
	Assignment of all entries to the given value. More...

void	operator= (const FixedList< bool, N > &list)
	Copy assignment. More...

void	operator= (FixedList< bool, N > &&list)
	Move assignment. More...

iterator	begin ()
	Return an iterator to begin traversing the FixedList. More...

const_iterator	begin () const
	Return const_iterator to begin traversing the constant FixedList. More...

iterator	end ()
	Return an iterator to end traversing the FixedList. More...

const_iterator	end () const
	Return const_iterator to end traversing the constant FixedList. More...

const_iterator	cbegin () const
	Return const_iterator to begin traversing the constant FixedList. More...

const_iterator	cend () const
	Return const_iterator to end traversing the constant FixedList. More...

reverse_iterator	rbegin ()
	Return reverse_iterator to begin reverse traversing the FixedList. More...

const_reverse_iterator	rbegin () const
	Return const_reverse_iterator to begin reverse traversing FixedList. More...

reverse_iterator	rend ()
	Return reverse_iterator to end reverse traversing the FixedList. More...

const_reverse_iterator	rend () const
	Return const_reverse_iterator to end reverse traversing FixedList. More...

const_reverse_iterator	crbegin () const
	Return const_reverse_iterator to begin reverse traversing FixedList. More...

const_reverse_iterator	crend () const
	Return const_reverse_iterator to end reverse traversing FixedList. More...

void	swap (FixedList< bool, N > &list)
	Swap lists by swapping the content of the individual list elements. More...

bool	operator== (const FixedList< bool, N > &list) const
	Equality operation on FixedLists of the same type. More...

bool	operator!= (const FixedList< bool, N > &list) const
	The opposite of the equality operation. Takes linear time. More...

bool	operator< (const FixedList< bool, N > &list) const
	Compare two FixedLists lexicographically. Takes linear time. More...

bool	operator> (const FixedList< bool, N > &list) const
	Compare two FixedLists lexicographically. Takes linear time. More...

bool	operator<= (const FixedList< bool, N > &list) const
	Return true if !(a > b). Takes linear time. More...

bool	operator>= (const FixedList< bool, N > &list) const
	Return true if !(a < b). Takes linear time. More...

Ostream &	writeList (Ostream &os, const label shortLen=0) const
	Write List, with line-breaks in ASCII when length exceeds shortLen. More...

Static Public Attributes
static constexpr direction	rank = 1
	Rank of a vector is 1. More...

Additional Inherited Members
Static Public Member Functions inherited from FixedList< bool, 3 >
static const FixedList< bool, N > &	null ()
	Return a null FixedList. More...

static constexpr bool	empty () noexcept
	Always false since zero-sized FixedList is compile-time disabled. More...

static constexpr label	size () noexcept
	Return the number of elements in the FixedList. More...

static constexpr unsigned	max_size () noexcept
	The dimensioned size (template parameter N) of the FixedList. More...

Public Attributes inherited from FixedList< bool, 3 >
const typedef bool *	const_pointer
	The pointer type for const access to value_type items. More...

const typedef bool &	const_reference
	The type used for reading from constant value_type objects. More...

const typedef bool *	const_iterator
	Random access iterator for traversing FixedList. More...

Protected Member Functions inherited from FixedList< bool, 3 >
void	writeEntry (Ostream &os) const
	Write the FixedList with its compound type. More...

Detailed Description

Specialized bundling of boolean values as a vector of 3 components, element access using x(), y() and z() member functions. It also has some methods similar to bitSet.

Note: The boolVector is not derived from Vector or VectorSpace since it does not share very many vector-like characteristics.

Source files

Definition at line 56 of file boolVector.H.

Member Enumeration Documentation

◆ components

enum components

Component labeling enumeration.

Enumerator
X
Y
Z

Definition at line 68 of file boolVector.H.

Constructor & Destructor Documentation

◆ boolVector() [1/6]

boolVector ( const boolVector & )

default

Copy construct.

◆ boolVector() [2/6]

boolVector ( boolVector && )

default

Move construct.

◆ boolVector() [3/6]

boolVector ( )

inline

Default construct, zero-initialized (ie, false)

Definition at line 30 of file boolVectorI.H.

◆ boolVector() [4/6]

boolVector ( const bool val )

inlineexplicit

Uniform construct with specified value.

Definition at line 36 of file boolVectorI.H.

◆ boolVector() [5/6]

boolVector	(	const bool	vx,
		const bool	vy,
		const bool	vz
	)

inline

Construct from three components.

Definition at line 43 of file boolVectorI.H.

References x, and y.

◆ boolVector() [6/6]

boolVector ( Istream & is )

inlineexplicit

Construct from Istream.

Definition at line 57 of file boolVectorI.H.

Member Function Documentation

◆ operator=() [1/3]

boolVector& operator= ( const boolVector & )

default

Copy assignment.

◆ operator=() [2/3]

boolVector& operator= ( boolVector && )

default

Move assignment.

◆ all()

bool all ( ) const

inline

True if all components are set.

Note: Method name compatibility with bitSet

Definition at line 65 of file boolVectorI.H.

◆ any()

bool any ( ) const

inline

True if any components are set.

Note: Method name compatibility with bitSet

Definition at line 75 of file boolVectorI.H.

◆ none()

bool none ( ) const

inline

True if no components are set.

Note: Method name compatibility with bitSet

Definition at line 85 of file boolVectorI.H.

References Foam::BitOps::any().

Here is the call graph for this function:

◆ count()

unsigned int count ( const bool on = true ) const

inline

Count number of items set.

Parameters

on	can be set to false to count the number of unset bits instead.

Note: Method name compatibility with bitSet

Definition at line 91 of file boolVectorI.H.

◆ x() [1/2]

bool x ( ) const

inline

The x component.

Definition at line 110 of file boolVectorI.H.

References boolVector::X.

◆ y() [1/2]

bool y ( ) const

inline

The y component.

Definition at line 111 of file boolVectorI.H.

References boolVector::Y.

◆ z() [1/2]

bool z ( ) const

inline

The z component.

Definition at line 112 of file boolVectorI.H.

References boolVector::Z.

◆ x() [2/2]

bool & x ( )

inline

The x component.

Definition at line 114 of file boolVectorI.H.

References boolVector::X.

◆ y() [2/2]

bool & y ( )

inline

The y component.

Definition at line 115 of file boolVectorI.H.

References boolVector::Y.

◆ z() [2/2]

bool & z ( )

inline

The z component.

Definition at line 116 of file boolVectorI.H.

References boolVector::Z.

◆ flip()

void flip ( )

inline

Invert all values.

Note: Method name compatibility with bitSet

Definition at line 119 of file boolVectorI.H.

◆ operator=() [3/3]

void operator= ( const bool value )

inline

Assignment of all entries to the given value.

Definition at line 130 of file boolVectorI.H.

References FixedList< T, N >::operator=().

Here is the call graph for this function:

Member Data Documentation

◆ rank

constexpr direction rank = 1

staticconstexpr

Rank of a vector is 1.

Definition at line 65 of file boolVector.H.

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

src/OpenFOAM/primitives/Vector/boolVector/boolVector.H
src/OpenFOAM/primitives/Vector/boolVector/boolVectorI.H

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ components

Constructor & Destructor Documentation

◆ boolVector() [1/6]

◆ boolVector() [2/6]

◆ boolVector() [3/6]

◆ boolVector() [4/6]

◆ boolVector() [5/6]

◆ boolVector() [6/6]

Member Function Documentation

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ all()

◆ any()

◆ none()

◆ count()

◆ x() [1/2]

◆ y() [1/2]

◆ z() [1/2]

◆ x() [2/2]

◆ y() [2/2]

◆ z() [2/2]

◆ flip()

◆ operator=() [3/3]

Member Data Documentation

◆ rank