---

Sundance::MultiIndex Class Reference

#include <MultiIndex.h>

List of all members.

Public Methods

Developer-only methods

• MultiIndex ()

  no detailed doc
  
  

• MultiIndex (int x)
• MultiIndex (int x, int y)
• MultiIndex (int x, int y, int z)
• MultiIndex (const MultiIndex &other)
• MultiIndex & operator= (const MultiIndex &other)
• bool operator== (const MultiIndex &other) const
• bool operator< (const MultiIndex &other) const
• int direction () const
• int order () const
• int order (int dir) const
• int maxDim () const
• void setFirstOrderDirection (int d)
• MultiIndex & operator+= (const MultiIndex &other)
• string toString () const
• XMLObject toXML () const

Private Attributes

• int dx_ [3]
• int order_
• int firstOrderDirection_

---

Detailed Description

An integer vector representing a multivariate derivative.

Definition at line 24 of file MultiIndex.h.

---

Constructor & Destructor Documentation

Sundance::MultiIndex::MultiIndex (    )  [inline]

Definition at line 74 of file MultiIndex.h. References dx_.

Sundance::MultiIndex::MultiIndex (  int    x )

Sundance::MultiIndex::MultiIndex (  int    x, int    y )

Sundance::MultiIndex::MultiIndex (  int    x, int    y, int    z )

Sundance::MultiIndex::MultiIndex (  const MultiIndex &    other )

---

Member Function Documentation

MultiIndex& Sundance::MultiIndex::operator= (  const MultiIndex &    other )

bool Sundance::MultiIndex::operator== (  const MultiIndex &    other )  const

bool Sundance::MultiIndex::operator< (  const MultiIndex &    other )  const

int Sundance::MultiIndex::direction (    )  const [inline]

Definition at line 78 of file MultiIndex.h. References firstOrderDirection_, and order_.

int Sundance::MultiIndex::order (    )  const [inline]

Definition at line 84 of file MultiIndex.h. References order_. Referenced by Sundance::operator<<(), and Sundance::toString().

int Sundance::MultiIndex::order (  int    dir )  const [inline]

Definition at line 89 of file MultiIndex.h. References dx_.

int Sundance::MultiIndex::maxDim (    )  const [inline]

Definition at line 54 of file MultiIndex.h.

void Sundance::MultiIndex::setFirstOrderDirection (  int    d )  [inline]

Definition at line 97 of file MultiIndex.h. References dx_, firstOrderDirection_, and order_.

MultiIndex& Sundance::MultiIndex::operator+= (  const MultiIndex &    other )

string Sundance::MultiIndex::toString (    )  const

XMLObject Sundance::MultiIndex::toXML (    )  const

---

Member Data Documentation

int Sundance::MultiIndex::dx_[3] [private]

Definition at line 67 of file MultiIndex.h. Referenced by MultiIndex(), order(), and setFirstOrderDirection().

int Sundance::MultiIndex::order_ [private]

Definition at line 68 of file MultiIndex.h. Referenced by direction(), order(), and setFirstOrderDirection().

int Sundance::MultiIndex::firstOrderDirection_ [private]

Definition at line 69 of file MultiIndex.h. Referenced by direction(), and setFirstOrderDirection().

---

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

• MultiIndex.h

---

Contact:

Kevin Long (krlong@ca.sandia.gov)


Documentation generated by