sliceRange Class Reference

A set of labels defined by a start, a length and a stride. More...

Classes
class	const_iterator
class	const_reverse_iterator
class	indexer

Public Types
typedef label	value_type
typedef label	size_type

Public Member Functions
constexpr	sliceRange () noexcept
constexpr	sliceRange (const label beg, const label len, const label stride) noexcept
	sliceRange (const FixedList< label, 3 > &coeffs)
constexpr label	start () const noexcept
constexpr label	size () const noexcept
constexpr label	stride () const noexcept
bool	empty () const noexcept
constexpr label	first () const noexcept
label	last () const noexcept
List< label >	labels () const
label	operator[] (const label i) const noexcept
	operator bool () const noexcept
indexer	generator () const
const_iterator	at (const label i) const
const_iterator	begin () const noexcept
const_iterator	cbegin () const noexcept
const_iterator	cend () const noexcept
const_iterator	end () const noexcept
const_reverse_iterator	rbegin () const noexcept
const_reverse_iterator	crbegin () const noexcept
const_reverse_iterator	rend () const noexcept
const_reverse_iterator	crend () const noexcept

Detailed Description

A set of labels defined by a start, a length and a stride.

Source files

• sliceRange.H
• sliceRange.C
• sliceRangeI.H

Definition at line 54 of file sliceRange.H.

Member Typedef Documentation

value_type

typedef label value_type

Definition at line 73 of file sliceRange.H.

size_type

typedef label size_type

Definition at line 76 of file sliceRange.H.

Constructor & Destructor Documentation

sliceRange() [1/3]

constexpr sliceRange ( )

inlineconstexprnoexcept

Definition at line 25 of file sliceRangeI.H.

sliceRange() [2/3]

constexpr sliceRange ( const label  beg, const label  len, const label  stride  )

inlineconstexprnoexcept

Definition at line 34 of file sliceRangeI.H.

sliceRange() [3/3]

sliceRange ( const FixedList< label, 3 > &  coeffs )

explicit

Definition at line 29 of file sliceRange.C.

Member Function Documentation

start()

constexpr label start ( ) const

inlineconstexprnoexcept

Definition at line 111 of file sliceRange.H.

size()

constexpr label size ( ) const

inlineconstexprnoexcept

Definition at line 117 of file sliceRange.H.

Referenced by Foam::operator<(), and Foam::operator==().

Here is the caller graph for this function:

stride()

constexpr label stride ( ) const

inlineconstexprnoexcept

Definition at line 123 of file sliceRange.H.

Referenced by Foam::operator<(), and Foam::operator==().

Here is the caller graph for this function:

empty()

bool empty ( ) const

inlinenoexcept

Definition at line 129 of file sliceRange.H.

first()

constexpr label first ( ) const

inlineconstexprnoexcept

Definition at line 135 of file sliceRange.H.

Referenced by Foam::operator<(), and Foam::operator==().

Here is the caller graph for this function:

last()

label last ( ) const

inlinenoexcept

Definition at line 141 of file sliceRange.H.

labels()

Foam::List< Foam::label > labels

(

)

const

Definition at line 39 of file sliceRange.C.

References stdFoam::cbegin(), and stdFoam::cend().

Here is the call graph for this function:

operator[]()

label operator[] ( const label  i ) const

inlinenoexcept

Definition at line 153 of file sliceRange.H.

operator bool()

operator bool ( ) const

inlineexplicitnoexcept

Definition at line 159 of file sliceRange.H.

References bool.

generator()

Foam::sliceRange::indexer generator ( ) const

inline

Definition at line 291 of file sliceRangeI.H.

at()

Foam::sliceRange::const_iterator at ( const label  i ) const

inline

Definition at line 298 of file sliceRangeI.H.

begin()

Foam::sliceRange::const_iterator begin ( ) const

inlinenoexcept

Definition at line 310 of file sliceRangeI.H.

cbegin()

Foam::sliceRange::const_iterator cbegin ( ) const

inlinenoexcept

Definition at line 317 of file sliceRangeI.H.

cend()

Foam::sliceRange::const_iterator cend ( ) const

inlinenoexcept

Definition at line 331 of file sliceRangeI.H.

end()

Foam::sliceRange::const_iterator end ( ) const

inlinenoexcept

Definition at line 324 of file sliceRangeI.H.

rbegin()

Foam::sliceRange::const_reverse_iterator rbegin ( ) const

inlinenoexcept

Definition at line 338 of file sliceRangeI.H.

crbegin()

Foam::sliceRange::const_reverse_iterator crbegin ( ) const

inlinenoexcept

Definition at line 345 of file sliceRangeI.H.

rend()

Foam::sliceRange::const_reverse_iterator rend ( ) const

inlinenoexcept

Definition at line 352 of file sliceRangeI.H.

crend()

Foam::sliceRange::const_reverse_iterator crend ( ) const

inlinenoexcept

Definition at line 359 of file sliceRangeI.H.

---

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

• src/OpenFOAM/primitives/ranges/sliceRange/sliceRange.H
• src/OpenFOAM/primitives/ranges/sliceRange/sliceRange.C
• src/OpenFOAM/primitives/ranges/sliceRange/sliceRangeI.H