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...

#include <boolVector.H>

Inheritance diagram for boolVector:

[legend]

Collaboration diagram for boolVector:

[legend]

Public Types
enum	components { X , Y , Z }
	Component labeling enumeration. More...
typedef bool	cmptType
	The component type is bool.
Public Types inherited from FixedList< bool, 3 >
typedef bool	value_type
	The value type the FixedList contains.
typedef bool *	pointer
	The pointer type for non-const access to value_type items.
typedef const bool *	const_pointer
	The pointer type for const access to value_type items.
typedef bool &	reference
	The type used for storing into value_type objects.
typedef const bool &	const_reference
	The type used for reading from constant value_type objects.
typedef bool *	iterator
	Random access iterator for traversing FixedList.
typedef const bool *	const_iterator
	Random access iterator for traversing FixedList.
typedef label	size_type
	The type to represent the size of a FixedList.
typedef label	difference_type
	The difference between iterator objects.
typedef std::reverse_iterator< iterator >	reverse_iterator
	Reverse iterator (non-const access).
typedef std::reverse_iterator< const_iterator >	const_reverse_iterator
	Reverse iterator (const access).

Public Member Functions
	boolVector (const boolVector &)=default
	Copy construct.
boolVector &	operator= (const boolVector &)=default
	Copy assignment.
	boolVector (boolVector &&)=default
	Move construct.
boolVector &	operator= (boolVector &&)=default
	Move assignment.
void	front ()=delete
	The front() accessor (from FixedList) has no purpose.
void	back ()=delete
	The back() accessor (from FixedList) has no purpose.
	boolVector ()
	Default construct, zero-initialized (ie, false).
	boolVector (const bool val)
	Uniform construct with specified value.
	boolVector (const bool vx, const bool vy, const bool vz)
	Construct from three components.
	boolVector (Istream &is)
	Construct from Istream.
bool	all () const noexcept
	True if all components are set.
bool	any () const noexcept
	True if any components are set.
bool	none () const noexcept
	True if no components are set.
unsigned int	count (const bool on=true) const
	Count number of items set.
bool	x () const noexcept
	The x component.
bool	y () const noexcept
	The y component.
bool	z () const noexcept
	The z component.
bool &	x () noexcept
	The x component.
bool &	y () noexcept
	The y component.
bool &	z () noexcept
	The z component.
void	flip ()
	Invert all values.
void	operator= (const bool value)
	Assignment of all entries to the given value.
Public Member Functions inherited from FixedList< bool, 3 >
	FixedList ()=default
	Default construct.
autoPtr< FixedList< bool, N > >	clone () const
	Clone.
const bool *	cdata () const noexcept
	Return pointer to the underlying array serving as data storage.
bool *	data () noexcept
	Return pointer to the underlying array serving as data storage.
const char *	cdata_bytes () const noexcept
	Return pointer to the underlying array serving as data storage,.
char *	data_bytes () noexcept
	Return pointer to the underlying array serving as data storage,.
bool &	get () noexcept
	Element access using compile-time indexing.
bool &	front () noexcept
	Access first element of the list, position [0].
bool &	back () noexcept
	Access last element of the list, position [N-1].
label	fcIndex (const label i) const noexcept
	Return the forward circular index, i.e. next index which returns to the first at the end of the list.
const bool &	fcValue (const label i) const
	Return forward circular value (ie, next value in the list).
label	rcIndex (const label i) const noexcept
	Return the reverse circular index, i.e. previous index which returns to the last at the beginning of the list.
const bool &	rcValue (const label i) const
	Return reverse circular value (ie, previous value in the list).
void	checkStart (const label start) const
	Check start is within valid range [0,size).
void	checkSize (const label size) const
	Check size is identical to template parameter N.
void	checkIndex (const label i) const
	Check index is within valid range [0,N).
bool	uniform () const
	True if all entries have identical values, and list is non-empty.
bool	contains (const bool &val) const
	True if the value is contained in the list.
label	find (const bool &val) const
	Find index of the first occurrence of the value.
label	rfind (const bool &val, label pos=-1) const
	Find index of the last occurrence of the value.
void	resize (const label n)
	Dummy function, to make FixedList consistent with List Any resizing is ignored (Fatal with bad sizing in full debug).
void	resize_fill (const label n, const bool &val)
	Set val for all elements. Any resizing is ignored (Fatal with bad sizing in full debug).
void	resize_nocopy (const label n)
	Dummy function, to make FixedList consistent with List Any resizing is ignored (Fatal with bad sizing in full debug).
void	setSize (const label n)
	Dummy function, to make FixedList consistent with List.
void	fill (const bool &val)
	Assign all entries to the given value.
void	moveFirst (const label i)
	Move element to the first position.
void	moveLast (const label i)
	Move element to the last position.
void	swapFirst (const label i)
	Swap element with the first element.
void	swapLast (const label i)
	Swap element with the last element.
void	transfer (FixedList< bool, N > &list)
	Transfer by swapping using a move assignment for the content of the individual list elements.
bool &	operator[] (const label i)
	Return element of FixedList.
void	operator= (const UList< bool > &list)
	Assignment to UList operator. Takes linear time.
iterator	begin () noexcept
	Return an iterator to begin traversing the FixedList.
iterator	end () noexcept
	Return an iterator to end traversing the FixedList.
const_iterator	cbegin () const noexcept
	Return const_iterator to begin traversing the constant FixedList.
const_iterator	cend () const noexcept
	Return const_iterator to end traversing the constant FixedList.
reverse_iterator	rbegin ()
	Return reverse_iterator to begin reverse traversing the FixedList.
reverse_iterator	rend ()
	Return reverse_iterator to end reverse traversing the FixedList.
const_reverse_iterator	crbegin () const
	Return const_reverse_iterator to begin reverse traversing FixedList.
const_reverse_iterator	crend () const
	Return const_reverse_iterator to end reverse traversing FixedList.
void	swap (FixedList< bool, N > &other)
	Swap lists by swapping the content of the individual list elements.
bool	operator== (const FixedList< bool, N > &list) const
	Equality operation on FixedLists of the same type.
bool	operator!= (const FixedList< bool, N > &list) const
	The opposite of the equality operation. Takes linear time.
bool	operator< (const FixedList< bool, N > &list) const
	Compare two FixedLists lexicographically. Takes linear time.
bool	operator> (const FixedList< bool, N > &list) const
	Compare two FixedLists lexicographically. Takes linear time.
bool	operator<= (const FixedList< bool, N > &list) const
	Return true if !(a > b). Takes linear time.
bool	operator>= (const FixedList< bool, N > &list) const
	Return true if !(a < b). Takes linear time.
Istream &	readList (Istream &is)
	Read from Istream, discarding contents of existing List.
Ostream &	writeList (Ostream &os, const label shortLen=0) const
	Write List, with line-breaks in ASCII when length exceeds shortLen.
bool &	first () noexcept
	Access first element of the list, position [0] - front().
bool &	last () noexcept
	Access last element of the list, position [N-1] - back().
bool	found (const bool &val, label pos=0) const
	Same as contains().

Static Public Attributes
static constexpr direction	rank = 1
	Rank of a vector is 1.
static constexpr direction	nComponents = 3
	Number of components in this vector space.

Additional Inherited Members
Static Public Member Functions inherited from FixedList< bool, 3 >
static const FixedList< bool, N > &	null () noexcept
	Return a null FixedList (reference to a nullObject). Read/write access is questionable.
static std::streamsize	size_bytes () noexcept
	Number of contiguous bytes for the list data,.
static std::streamsize	byteSize ()
	Number of contiguous bytes for the list data, runtime FatalError if type is not contiguous.
static constexpr bool	empty () noexcept
	Always false since zero-sized FixedList is compile-time disabled.
static constexpr label	size () noexcept
	Return the number of elements in the FixedList.
static constexpr unsigned	max_size () noexcept
	The dimensioned size (template parameter N) of the FixedList.
Protected Member Functions inherited from FixedList< bool, 3 >
void	writeEntry (Ostream &os) const
	Write the FixedList with its compound type.

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 52 of file boolVector.H.

Member Typedef Documentation

◆ cmptType

typedef bool cmptType

The component type is bool.

Definition at line 63 of file boolVector.H.

Member Enumeration Documentation

◆ components

enum components

Component labeling enumeration.

Enumerator
X
Y
Z

Definition at line 81 of file boolVector.H.

Constructor & Destructor Documentation

◆ boolVector() [1/6]

boolVector ( const boolVector & )

default

Copy construct.

References boolVector().

Referenced by boolVector(), boolVector(), operator=(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ boolVector() [2/6]

boolVector ( boolVector && )

default

Move construct.

References boolVector().

Here is the call graph for this function:

◆ boolVector() [3/6]

boolVector ( )

inline

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

Definition at line 23 of file boolVectorI.H.

References FixedList< bool, 3 >::FixedList().

Here is the call graph for this function:

◆ boolVector() [4/6]

boolVector ( const bool val )

inlineexplicit

Uniform construct with specified value.

Definition at line 29 of file boolVectorI.H.

References FixedList< bool, 3 >::FixedList().

Here is the call graph for this function:

◆ boolVector() [5/6]

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

inline

Construct from three components.

Definition at line 35 of file boolVectorI.H.

References x, y, and z().

Here is the call graph for this function:

◆ boolVector() [6/6]

boolVector ( Istream & is )

inlineexplicit

Construct from Istream.

Definition at line 48 of file boolVectorI.H.

References FixedList< bool, 3 >::FixedList().

Here is the call graph for this function:

Member Function Documentation

◆ operator=() [1/3]

boolVector & operator= ( const boolVector & )

default

Copy assignment.

References boolVector().

Here is the call graph for this function:

◆ operator=() [2/3]

boolVector & operator= ( boolVector && )

default

Move assignment.

References boolVector().

Here is the call graph for this function:

◆ front()

void front ( )

delete

The front() accessor (from FixedList) has no purpose.

◆ back()

void back ( )

delete

The back() accessor (from FixedList) has no purpose.

References any(), count(), Foam::noexcept, and none().

Here is the call graph for this function:

◆ all()

bool all ( ) const

inlinenoexcept

True if all components are set.

Note: Method name compatibility with bitSet

Definition at line 56 of file boolVectorI.H.

References Foam::noexcept, x, y, and z().

Here is the call graph for this function:

◆ any()

bool any ( ) const

inlinenoexcept

True if any components are set.

Note: Method name compatibility with bitSet

Definition at line 62 of file boolVectorI.H.

References Foam::noexcept, x, y, and z().

Referenced by back(), and none().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ none()

bool none ( ) const

inlinenoexcept

True if no components are set.

Note: Method name compatibility with bitSet

Definition at line 68 of file boolVectorI.H.

References any(), and Foam::noexcept.

Referenced by back().

Here is the call graph for this function:

Here is the caller 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 74 of file boolVectorI.H.

Referenced by back().

Here is the caller graph for this function:

◆ x() [1/2]

bool x ( ) const

inlinenoexcept

The x component.

Definition at line 184 of file boolVector.H.

References FixedList< bool, 3 >::get(), Foam::noexcept, and x().

Referenced by NURBS3DVolume::confineControlPoint(), and x().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ y() [1/2]

bool y ( ) const

inlinenoexcept

The y component.

Definition at line 189 of file boolVector.H.

References FixedList< bool, 3 >::get(), and Foam::noexcept.

Referenced by NURBS3DVolume::confineControlPoint().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ z() [1/2]

bool z ( ) const

inlinenoexcept

The z component.

Definition at line 194 of file boolVector.H.

References FixedList< bool, 3 >::get(), and Foam::noexcept.

Referenced by all(), any(), boolVector(), NURBS3DVolume::confineControlPoint(), and flip().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ x() [2/2]

bool & x ( )

inlinenoexcept

The x component.

Definition at line 199 of file boolVector.H.

References FixedList< bool, 3 >::get(), and Foam::noexcept.

Here is the call graph for this function:

◆ y() [2/2]

bool & y ( )

inlinenoexcept

The y component.

Definition at line 204 of file boolVector.H.

References FixedList< bool, 3 >::get(), and Foam::noexcept.

Here is the call graph for this function:

◆ z() [2/2]

bool & z ( )

inlinenoexcept

The z component.

Definition at line 209 of file boolVector.H.

References FixedList< bool, 3 >::get(), and Foam::noexcept.

Here is the call graph for this function:

◆ flip()

void flip ( )

inline

Invert all values.

Note: Method name compatibility with bitSet

Definition at line 93 of file boolVectorI.H.

References x, y, and z().

Here is the call graph for this function:

◆ operator=() [3/3]

void operator= ( const bool value )

inline

Assignment of all entries to the given value.

Definition at line 103 of file boolVectorI.H.

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

Here is the call graph for this function:

Member Data Documentation

◆ rank

direction rank = 1

staticconstexpr

Rank of a vector is 1.

Definition at line 71 of file boolVector.H.

◆ nComponents

direction nComponents = 3

staticconstexpr

Number of components in this vector space.

Definition at line 76 of file boolVector.H.

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

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

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ cmptType

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]

◆ front()

◆ back()

◆ 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

◆ nComponents