Epetra_IntVector Class Reference

Epetra_IntVector: A class for constructing and using dense integer vectors on a parallel computer. More...

#include <Epetra_IntVector.h>

Inheritance diagram for Epetra_IntVector:
Inheritance graph
[legend]

List of all members.

Private Member Functions

int AllocateForCopy ()
int DoCopy (int *V)
int AllocateForView ()
int DoView (int *V)
int CheckSizes (const Epetra_SrcDistObject &A)
 Allows the source and target (this) objects to be compared for compatibility, return nonzero if not.
int CopyAndPermute (const Epetra_SrcDistObject &Source, int NumSameIDs, int NumPermuteIDs, int *PermuteToLIDs, int *PermuteFromLIDs, const Epetra_OffsetIndex *Indexor)
 Perform ID copies and permutations that are on processor.
int PackAndPrepare (const Epetra_SrcDistObject &Source, int NumExportIDs, int *ExportLIDs, int &LenExports, char *&Exports, int &SizeOfPacket, int *Sizes, bool &VarSizes, Epetra_Distributor &Distor)
 Perform any packing or preparation required for call to DoTransfer().
int UnpackAndCombine (const Epetra_SrcDistObject &Source, int NumImportIDs, int *ImportLIDs, int LenImports, char *Imports, int &SizeOfPacket, Epetra_Distributor &Distor, Epetra_CombineMode CombineMode, const Epetra_OffsetIndex *Indexor)
 Perform any unpacking and combining after call to DoTransfer().

Private Attributes

int * Values_
bool UserAllocated_
bool Allocated_

Constructors/destructors



 Epetra_IntVector (const Epetra_BlockMap &Map, bool zeroOut=true)
 Basic Epetra_IntVector constuctor.
 Epetra_IntVector (const Epetra_IntVector &Source)
 Epetra_IntVector copy constructor.
 Epetra_IntVector (Epetra_DataAccess CV, const Epetra_BlockMap &Map, int *V)
 Set vector values from user array.
virtual ~Epetra_IntVector ()
 Epetra_IntVector destructor.

Post-construction modification methods



int PutValue (int Value)
 Set all elements of the vector to Value.

Extraction methods



int ExtractCopy (int *V) const
 Put vector values into user-provided array.
int ExtractView (int **V) const
 Set user-provided address of V.

Mathematical methods



int MaxValue ()
 Find maximum value.
int MinValue ()
 Find minimum value.

Overloaded operators



Epetra_IntVectoroperator= (const Epetra_IntVector &Source)
 = Operator.
int & operator[] (int index)
 Element access function.
const int & operator[] (int index) const
 Element access function.

Attribute access functions



int * Values () const
 Returns a pointer to an array containing the values of this vector.
int MyLength () const
 Returns the local vector length on the calling processor of vectors in the multi-vector.
int GlobalLength () const
 Returns the global vector length of vectors in the multi-vector.

I/O methods



virtual void Print (ostream &os) const
 Print method.

Detailed Description

Epetra_IntVector: A class for constructing and using dense integer vectors on a parallel computer.

The Epetra_IntVector class enables the construction and use of integer dense vectors in a distributed memory environment. The distribution of the dense vector is determined in part by a Epetra_Comm object and a Epetra_Map (or Epetra_LocalMap or Epetra_BlockMap).

Distributed Global vs. Replicated Local

Constructing Epetra_IntVectors

There are four Epetra_IntVector constructors. The first is a basic constructor that allocates space and sets all values to zero, the second is a copy constructor. The third and fourth constructors work with user data. These constructors have two data access modes:

  1. Copy mode - Allocates memory and makes a copy of the user-provided data. In this case, the user data is not needed after construction.
  2. View mode - Creates a "view" of the user data. In this case, the user data is required to remain intact for the life of the vector.
Warning:
View mode is extremely dangerous from a data hiding perspective. Therefore, we strongly encourage users to develop code using Copy mode first and only use the View mode in a secondary optimization phase.

All Epetra_IntVector constructors require a map argument that describes the layout of elements on the parallel machine. Specifically, map is a Epetra_Map, Epetra_LocalMap or Epetra_BlockMap object describing the desired memory layout for the vector.

There are four different Epetra_IntVector constructors:

Extracting Data from Epetra_IntVectors

Once a Epetra_IntVector is constructed, it is possible to extract a copy of the values or create a view of them.

Warning:
ExtractView functions are extremely dangerous from a data hiding perspective. For both ExtractView fuctions, there is a corresponding ExtractCopy function. We strongly encourage users to develop code using ExtractCopy functions first and only use the ExtractView functions in a secondary optimization phase.

There are two Extract functions:

Warning:
A Epetra_Map, Epetra_LocalMap or Epetra_BlockMap object is required for all Epetra_IntVector constructors.

Definition at line 111 of file Epetra_IntVector.h.


Constructor & Destructor Documentation

Epetra_IntVector::Epetra_IntVector ( const Epetra_BlockMap Map,
bool  zeroOut = true 
)

Basic Epetra_IntVector constuctor.

Creates a Epetra_IntVector object and, by default, fills with zero values.

Parameters:
In Map - A Epetra_LocalMap, Epetra_Map or Epetra_BlockMap.
Warning:
Note that, because Epetra_LocalMap derives from Epetra_Map and Epetra_Map derives from Epetra_BlockMap, this constructor works for all three types of Epetra map classes.
Parameters:
In zeroOut - If true then the allocated memory will be zeroed out initialy. If false then this memory will not be touched which can be significantly faster.
Returns:
Pointer to a Epetra_IntVector.

Definition at line 34 of file Epetra_IntVector.cpp.

Epetra_IntVector::Epetra_IntVector ( const Epetra_IntVector Source  ) 

Epetra_IntVector copy constructor.

Definition at line 44 of file Epetra_IntVector.cpp.

Epetra_IntVector::Epetra_IntVector ( Epetra_DataAccess  CV,
const Epetra_BlockMap Map,
int *  V 
)

Set vector values from user array.

Parameters:
In Epetra_DataAccess - Enumerated type set to Copy or View.
In Map - A Epetra_LocalMap, Epetra_Map or Epetra_BlockMap.
In V - Pointer to an array of integer numbers..
Returns:
Integer error code, set to 0 if successful.

See Detailed Description section for further discussion.

Definition at line 54 of file Epetra_IntVector.cpp.

Epetra_IntVector::~Epetra_IntVector (  )  [virtual]

Epetra_IntVector destructor.

Definition at line 70 of file Epetra_IntVector.cpp.


Member Function Documentation

int Epetra_IntVector::PutValue ( int  Value  ) 

Set all elements of the vector to Value.

Definition at line 135 of file Epetra_IntVector.cpp.

int Epetra_IntVector::ExtractCopy ( int *  V  )  const

Put vector values into user-provided array.

Parameters:
Out V - Pointer to memory space that will contain the vector values.
Returns:
Integer error code, set to 0 if successful.

Definition at line 120 of file Epetra_IntVector.cpp.

int Epetra_IntVector::ExtractView ( int **  V  )  const

Set user-provided address of V.

Parameters:
Out V - Address of a pointer to that will be set to point to the values of the vector.
Returns:
Integer error code, set to 0 if successful.

Definition at line 128 of file Epetra_IntVector.cpp.

int Epetra_IntVector::MaxValue (  ) 

Find maximum value.

Returns:
Maximum value across all processors.

Definition at line 141 of file Epetra_IntVector.cpp.

int Epetra_IntVector::MinValue (  ) 

Find minimum value.

Returns:
Minimum value across all processors.

Definition at line 152 of file Epetra_IntVector.cpp.

Epetra_IntVector & Epetra_IntVector::operator= ( const Epetra_IntVector Source  ) 

= Operator.

Parameters:
In A - Epetra_IntVector to copy.
Returns:
Epetra_IntVector.

Definition at line 163 of file Epetra_IntVector.cpp.

int& Epetra_IntVector::operator[] ( int  index  )  [inline]

Element access function.

Returns:
V[Index].

Definition at line 222 of file Epetra_IntVector.h.

const int& Epetra_IntVector::operator[] ( int  index  )  const [inline]

Element access function.

Returns:
V[Index].

Definition at line 227 of file Epetra_IntVector.h.

int* Epetra_IntVector::Values (  )  const [inline]

Returns a pointer to an array containing the values of this vector.

Definition at line 234 of file Epetra_IntVector.h.

int Epetra_IntVector::MyLength (  )  const [inline]

Returns the local vector length on the calling processor of vectors in the multi-vector.

Definition at line 237 of file Epetra_IntVector.h.

int Epetra_IntVector::GlobalLength (  )  const [inline]

Returns the global vector length of vectors in the multi-vector.

Definition at line 240 of file Epetra_IntVector.h.

void Epetra_IntVector::Print ( ostream &  os  )  const [virtual]

Print method.

Reimplemented from Epetra_DistObject.

Definition at line 175 of file Epetra_IntVector.cpp.

int Epetra_IntVector::AllocateForCopy (  )  [private]

Definition at line 77 of file Epetra_IntVector.cpp.

int Epetra_IntVector::DoCopy ( int *  V  )  [private]

Definition at line 94 of file Epetra_IntVector.cpp.

int Epetra_IntVector::AllocateForView (  )  [private]

Definition at line 102 of file Epetra_IntVector.cpp.

int Epetra_IntVector::DoView ( int *  V  )  [private]

Definition at line 112 of file Epetra_IntVector.cpp.

int Epetra_IntVector::CheckSizes ( const Epetra_SrcDistObject Source  )  [private, virtual]

Allows the source and target (this) objects to be compared for compatibility, return nonzero if not.

Implements Epetra_DistObject.

Definition at line 229 of file Epetra_IntVector.cpp.

int Epetra_IntVector::CopyAndPermute ( const Epetra_SrcDistObject Source,
int  NumSameIDs,
int  NumPermuteIDs,
int *  PermuteToLIDs,
int *  PermuteFromLIDs,
const Epetra_OffsetIndex Indexor 
) [private, virtual]

Perform ID copies and permutations that are on processor.

Implements Epetra_DistObject.

Definition at line 236 of file Epetra_IntVector.cpp.

int Epetra_IntVector::PackAndPrepare ( const Epetra_SrcDistObject Source,
int  NumExportIDs,
int *  ExportLIDs,
int &  LenExports,
char *&  Exports,
int &  SizeOfPacket,
int *  Sizes,
bool &  VarSizes,
Epetra_Distributor Distor 
) [private, virtual]

Perform any packing or preparation required for call to DoTransfer().

Implements Epetra_DistObject.

Definition at line 327 of file Epetra_IntVector.cpp.

int Epetra_IntVector::UnpackAndCombine ( const Epetra_SrcDistObject Source,
int  NumImportIDs,
int *  ImportLIDs,
int  LenImports,
char *  Imports,
int &  SizeOfPacket,
Epetra_Distributor Distor,
Epetra_CombineMode  CombineMode,
const Epetra_OffsetIndex Indexor 
) [private, virtual]

Perform any unpacking and combining after call to DoTransfer().

Implements Epetra_DistObject.

Definition at line 401 of file Epetra_IntVector.cpp.


Member Data Documentation

int* Epetra_IntVector::Values_ [private]

Definition at line 286 of file Epetra_IntVector.h.

Definition at line 287 of file Epetra_IntVector.h.

Definition at line 288 of file Epetra_IntVector.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Wed Apr 13 09:58:45 2011 for Epetra Package Browser (Single Doxygen Collection) by  doxygen 1.6.3