one::minus Class Reference

A class representing the concept of -1. More...

Public Types
typedef minus	value_type

Public Member Functions
constexpr	minus () noexcept
	Default construct. More...
constexpr	minus (Istream &) noexcept
	Construct from Istream consumes no content. More...
constexpr	operator label () const noexcept
	Return -1 for label. More...
constexpr	operator float () const noexcept
	Return -1 for float. More...
constexpr	operator double () const noexcept
	Return -1 for double. More...
one::minus	operator[] (const label) const noexcept
	Component-wise or element-wise access returns minus one. More...

Detailed Description

A class representing the concept of -1.

Note

this class must never be derived from Foam::one, since this could potentially mask its behaviour.

Definition at line 122 of file one.H.

Member Typedef Documentation

value_type

typedef minus value_type

Definition at line 126 of file one.H.

Constructor & Destructor Documentation

minus() [1/2]

constexpr minus ( )

inlinenoexcept

Default construct.

Definition at line 131 of file one.H.

minus() [2/2]

constexpr minus ( Istream &  )

inlineexplicitnoexcept

Construct from Istream consumes no content.

Definition at line 136 of file one.H.

Member Function Documentation

operator label()

constexpr operator label ( ) const

inlinenoexcept

Return -1 for label.

Definition at line 142 of file one.H.

operator float()

constexpr operator float ( ) const

inlinenoexcept

Return -1 for float.

Definition at line 150 of file one.H.

operator double()

constexpr operator double ( ) const

inlinenoexcept

Return -1 for double.

Definition at line 158 of file one.H.

operator[]()

one::minus operator[] ( const label  ) const

inlinenoexcept

Component-wise or element-wise access returns minus one.

Definition at line 166 of file one.H.

---

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

• src/OpenFOAM/primitives/one/one.H