fiber_bundle::ternary_index Class Reference

A triple of indices (i,j, k). More...

#include <ternary_index.h>

Public Member Functions
	ternary_index ()
	Default Constructor; creates an instance with i == j == k == 0;. More...
	ternary_index (unary_index xi, unary_index xj, unary_index xk)
	Creates an instance with i == xi, j == xj, k == xk. More...
ternary_index	operator+ (const ternary_index &xother) const
	Sum. More...
ternary_index &	operator+= (const ternary_index &xother)
	Self-allocated sum. More...

Public Attributes
unary_index	i
	The first index. More...
unary_index	j
	The second index. More...
unary_index	k
	The third index. More...

Detailed Description

A triple of indices (i,j, k).

Definition at line 45 of file ternary_index.h.

Constructor & Destructor Documentation

ternary_index() [1/2]

fiber_bundle::ternary_index::ternary_index ( )

inline

Default Constructor; creates an instance with i == j == k == 0;.

Postcondition

• i == 0

• j == 0

• k == 0

Definition at line 67 of file ternary_index.h.

ternary_index() [2/2]

fiber_bundle::ternary_index::ternary_index ( unary_index  xi, unary_index  xj, unary_index  xk  )

inline

Creates an instance with i == xi, j == xj, k == xk.

Postcondition

• i == xi

• j == xj

• k == xk

Definition at line 91 of file ternary_index.h.

Member Function Documentation

operator+()

ternary_index fiber_bundle::ternary_index::operator+ ( const ternary_index &  xother ) const

inline

Sum.

Postcondition

• result.i = i + xother.i

• result.j = j + xother.j

• result.k = k + xother.k

Definition at line 130 of file ternary_index.h.

References i, j, and k.

operator+=()

ternary_index& fiber_bundle::ternary_index::operator+= ( const ternary_index &  xother )

inline

Self-allocated sum.

Postcondition

• i = old_i + xother.i

• j = old_j + xother.j

• k = old_k + xother.k

Definition at line 152 of file ternary_index.h.

References i, j, and k.

Member Data Documentation

i

unary_index fiber_bundle::ternary_index::i

The first index.

Definition at line 52 of file ternary_index.h.

Referenced by fiber_bundle::ternary_index_space::contains(), fiber_bundle::ternary_index_space::neighbor_list(), operator+(), operator+=(), fiber_bundle::operator<<(), fiber_bundle::ternary_index_space::to_col_major_offset(), and fiber_bundle::ternary_index_space::to_row_major_offset().

j

unary_index fiber_bundle::ternary_index::j

The second index.

Definition at line 57 of file ternary_index.h.

Referenced by fiber_bundle::ternary_index_space::contains(), fiber_bundle::ternary_index_space::neighbor_list(), operator+(), operator+=(), fiber_bundle::operator<<(), fiber_bundle::ternary_index_space::to_col_major_offset(), and fiber_bundle::ternary_index_space::to_row_major_offset().

k

unary_index fiber_bundle::ternary_index::k

The third index.

Definition at line 62 of file ternary_index.h.

Referenced by fiber_bundle::ternary_index_space::contains(), fiber_bundle::ternary_index_space::neighbor_list(), operator+(), operator+=(), fiber_bundle::operator<<(), fiber_bundle::ternary_index_space::to_col_major_offset(), and fiber_bundle::ternary_index_space::to_row_major_offset().

---

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

• ternary_index.h