SourcePro® API Reference Guide

  
Loading...
Searching...
No Matches
Public Member Functions | List of all members
RWMultiIndex Class Reference
SourcePro Analysis » Essential Math Module » Math Collections

An n-dimensional index class for traversing arrays of arbitrary dimension. More...

#include <rw/array.h>

Inheritance diagram for RWMultiIndex:
RWMathVec< int > RWVecView RWDataView

Public Member Functions

 RWMultiIndex (const RWIntVec &n)
 
 operator void * ()
 
void operator++ ()
 
- Public Member Functions inherited from RWMathVec< int >
 RWMathVec ()
 
 RWMathVec (const char *s)
 
 RWMathVec (const int *dat, size_t n)
 
 RWMathVec (const RWMathVec< double > &re, const RWMathVec< double > &im)
 
 RWMathVec (const RWMathVec< int > &a)
 
 RWMathVec (const RWMathVecPick< int > &p)
 
 RWMathVec (size_t n, const int &initval)
 
 RWMathVec (size_t n, const int &initval, const int &incr)
 
 RWMathVec (size_t n, RWRandInterface &r)
 
 RWMathVec (size_t n, RWUninitialized)
 
RWMathVec< int > apply (typename rw_numeric_traits< int >::mathFunType f) const
 
RWMathVec< norm_type > apply2 (mathFunType2 f) const
 
iterator begin ()
 
const_iterator begin () const
 
size_t binaryStoreSize () const
 
const_iterator cbegin () const
 
const_iterator cend () const
 
RWMathVec< int > copy () const
 
const_reverse_iterator crbegin () const
 
const_reverse_iterator crend () const
 
int * data ()
 
const int * data () const
 
RWMathVec< int > deepCopy () const
 
void deepenShallowCopy ()
 
iterator end ()
 
const_iterator end () const
 
size_t length () const
 
 operator RWMathVec< promote_type > ()
 
RWMathVec< int > operator() (const RWSlice &)
 
const RWMathVec< int > operator() (const RWSlice &) const
 
int & operator() (int i)
 
int operator() (int i) const
 
RWMathVec< int > & operator*= (const int &v)
 
RWMathVec< int > & operator*= (const RWMathVec< int > &v)
 
RWMathVec< int > & operator++ ()
 
void operator++ (int)
 
RWMathVec< int > & operator+= (const int &v)
 
RWMathVec< int > & operator+= (const RWMathVec< int > &v)
 
RWMathVec< int > & operator-- ()
 
void operator-- (int)
 
RWMathVec< int > & operator-= (const int &v)
 
RWMathVec< int > & operator-= (const RWMathVec< int > &v)
 
RWMathVec< int > & operator/= (const int &v)
 
RWMathVec< int > & operator/= (const RWMathVec< int > &v)
 
RWMathVec< int > & operator= (const int &v)
 
RWMathVec< int > & operator= (const RWMathVec< int > &v)
 
RWMathVec< int > & operator= (const RWMathVecPick< int > &v)
 
RWMathVec< int > operator[] (const RWSlice &)
 
const RWMathVec< int > operator[] (const RWSlice &) const
 
int & operator[] (int i)
 
int operator[] (int i) const
 
RWMathVecPick< int > pick (const RWIntVec &v)
 
reverse_iterator rbegin ()
 
const_reverse_iterator rbegin () const
 
RWMathVec< int > & reference (const RWMathVec< int > &v)
 
reverse_iterator rend ()
 
const_reverse_iterator rend () const
 
void reshape (size_t n)
 
void resize (size_t n)
 
void restoreFrom (RWFile &)
 
void restoreFrom (RWvistream &)
 
void saveOn (RWFile &) const
 
void saveOn (RWvostream &) const
 
RWMathVec< int > slice (int start, size_t n, int stride=1) const
 
int stride () const
 
- Public Member Functions inherited from RWVecView
size_t length () const
 
int stride () const
 

Additional Inherited Members

- Public Types inherited from RWMathVec< int >
typedef RWMathVecConstIterator< int > const_iterator
 
typedef std::reverse_iterator< const_iterator > const_reverse_iterator
 
typedef RWMathVecIterator< int > iterator
 
typedef rw_numeric_traits< int >::mathFunType mathFunType
 
typedef rw_numeric_traits< int >::mathFunType2 mathFunType2
 
typedef rw_numeric_traits< int >::norm_type norm_type
 
typedef rw_numeric_traits< int >::promote_type promote_type
 
typedef std::reverse_iterator< iterator > reverse_iterator
 
- Public Types inherited from RWDataView
enum  Storage { COLUMN_MAJOR , ROW_MAJOR , RWEITHER }
 
- Related Symbols inherited from RWMathVec< int >
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 Returns a complex vector v containing the complex Nth roots of unity.
 
 Returns a complex vector v containing the complex Nth roots of unity.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Detailed Description

Class RWMultiIndex is an n-dimensional index class. It is a tool for traversing arrays of arbitrary dimension. As shown in the Example below, you can use RWMultiIndex to help you write subroutines that operate on arrays of arbitrary dimension. Using automatic type conversion, you can then call these subroutines with vectors, matrices, or arrays. For instance, you can use the Example subroutine as follows:

RWMathVec<int> v;
RWGenMat<int> A;
RWMathArray<int> X;
int vZeros = numZeros(v);
int AZeros = numZeros(A);
int XZeros = numZeros(X)
RWGenMat
A templatized general matrix class.
Definition genmat.h:735
RWMathArray
A templatized arbitrary dimension array class.
Definition mtharray.h:884
RWMathVec
A templatized vector class.
Definition mathvec.h:645
Synopsis
// Any array class will do
#include <rw/math/mtharray.h>
// n is an IntVec
for (RWMultiIndex i(n); i; ++i) {
}
RWMultiIndex
An n-dimensional index class for traversing arrays of arbitrary dimension.
Definition array.h:175
Example
#include <rw/math/mtharray.h>
int numZeros(const RWMathArray<int>& X) // Count the number
// of zeros in X
{
int count = 0;
for (RWMultiIndex i(X.length()); i; ++i) {
if (X(i) == 0) {
++count;
}
}
return count;
}
RWMathArray::length
RWIntVec length() const
Definition mtharray.h:1291

Constructor & Destructor Documentation

◆ RWMultiIndex()

RWMultiIndex::RWMultiIndex ( const RWIntVec & n)
explicit

Constructs an index to count from 0 to n.

Member Function Documentation

◆ operator void *()

RWMultiIndex::operator void * ( )
inline

Returns 0 if the index is no longer valid. An index becomes invalid when it is incremented beyond its limit.

◆ operator++()

void RWMultiIndex::operator++ ( )

Increments the index.

Copyright © 2025 Rogue Wave Software, Inc., a Perforce company. All Rights Reserved.