fiber_bundle::binary_index Class Reference

A pair of indices (i,j). More...

#include <binary_index.h>

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

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

Detailed Description

A pair of indices (i,j).

Definition at line 44 of file binary_index.h.

Constructor & Destructor Documentation

binary_index() [1/2]

fiber_bundle::binary_index::binary_index ( )

inline

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

Postcondition

• i == 0

• j == 0

Definition at line 61 of file binary_index.h.

binary_index() [2/2]

fiber_bundle::binary_index::binary_index ( unary_index  xi, unary_index  xj  )

inline

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

Postcondition

• i == xi

• j == xj

Definition at line 83 of file binary_index.h.

Member Function Documentation

operator+()

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

inline

Sum.

Postcondition

• result.i = i + xother.i

• result.j = j + xother.j

Definition at line 120 of file binary_index.h.

References i, and j.

operator+=()

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

inline

Self-allocated sum.

Postcondition

• i = old_i + xother.i

• j = old_j + xother.j

Definition at line 141 of file binary_index.h.

References i, and j.

Member Data Documentation

i

unary_index fiber_bundle::binary_index::i

The first index.

Definition at line 51 of file binary_index.h.

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

j

unary_index fiber_bundle::binary_index::j

The second index.

Definition at line 56 of file binary_index.h.

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

---

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

• binary_index.h