IMP logo
IMP Reference Guide  develop.62cd6b8d93,2024/10/30
The Integrative Modeling Platform
IMP::algebra::ExtendedGridIndexD< D > Class Template Reference

An index in an infinite grid on space. More...

#include <IMP/algebra/grid_indexes.h>

+ Inheritance diagram for IMP::algebra::ExtendedGridIndexD< D >:

Detailed Description

template<int D>
class IMP::algebra::ExtendedGridIndexD< D >

An index in an infinite grid on space.

Definition at line 31 of file grid_indexes.h.

Public Types

typedef const int * iterator
 

Public Member Functions

 ExtendedGridIndexD (Ints vals)
 Create a grid cell from three arbitrary indexes. More...
 
template<class It >
 ExtendedGridIndexD (It b, It e)
 
 ExtendedGridIndexD (int x)
 
 ExtendedGridIndexD (int x, int y)
 
 ExtendedGridIndexD (int x, int y, int z)
 
 ExtendedGridIndexD (int i, int j, int k, int l)
 
 ExtendedGridIndexD (int i, int j, int k, int l, int m)
 
 ExtendedGridIndexD (int i, int j, int k, int l, int m, int n)
 
const int at (unsigned int) const
 Get the ith component (i=0,1,2) More...
 
int & at (unsigned int)
 
iterator begin () const
 
iterator end () const
 
unsigned int get_dimension () const
 
ExtendedGridIndexD< D > get_offset (int i, int j, int k) const
 
ExtendedGridIndexD< D > get_uniform_offset (int ii) const
 
 IMP_COMPARISONS (ExtendedGridIndexD)
 
 IMP_HASHABLE_INLINE (ExtendedGridIndexD, return boost::hash_range(begin(), end()))
 
const int operator[] (unsigned int) const
 
int & operator[] (unsigned int)
 
void show (std::ostream &out=std::cout) const
 

Constructor & Destructor Documentation

template<int D>
IMP::algebra::ExtendedGridIndexD< D >::ExtendedGridIndexD ( Ints  vals)
explicit

Create a grid cell from three arbitrary indexes.

Note
Only use this from Python.

Definition at line 73 of file grid_indexes.h.

Member Function Documentation

template<int D>
const int IMP::algebra::ExtendedGridIndexD< D >::at ( unsigned  int) const

Get the ith component (i=0,1,2)


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