PyTrilinos::Epetra::Epetra_IntSerialDenseVector Class Reference

Inheritance diagram for PyTrilinos::Epetra::Epetra_IntSerialDenseVector:

Inheritance graph
[legend]
Collaboration diagram for PyTrilinos::Epetra::Epetra_IntSerialDenseVector:

Collaboration graph
[legend]

List of all members.

Public Member Functions

def __init__
def Size
def Resize
def __call__
def Random
def Length
def Values
def CV
def __init__
def Size
def Resize
def __call__
def Random
def Length
def Values
def CV

Public Attributes

 this


Detailed Description

Epetra_IntSerialDenseVector: A class for constructing and using dense
vectors.

The Epetra_IntSerialDenseVector class enables the construction and use
of integer-valued, dense vectors. It derives from the
Epetra_IntSerialDenseMatrix class.

The Epetra_IntSerialDenseVector class is intended to provide
convenient vector notation but derives all signficant functionality
from Epetra_IntSerialDenseMatrix.

Constructing Epetra_IntSerialDenseVector Objects

There are three Epetra_IntSerialDenseVector constructors. The first
constructs a zero-length object which should be made to appropriate
length using the Size() or Resize() functions and then filled with the
[] or () operators. The second constructs an object sized to the
dimension specified, which should be filled with the [] or ()
operators. The third is a constructor that accepts user data as a 1D
array, and the fourth is a copy constructor. The third constructor has
two data access modes (specified by the Epetra_DataAccess argument):
Copy mode - Allocates memory and makes a copy of the user-provided
data. In this case, the user data is not needed after construction.

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 object.

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.  Extracting Data from Epetra_IntSerialDenseVector
Objects

Once a Epetra_IntSerialDenseVector is constructed, it is possible to
view the data via access functions.

WARNING:  Use of these access functions cam be extremely dangerous
from a data hiding perspective.

C++ includes: Epetra_IntSerialDenseVector.h 

Member Function Documentation

def PyTrilinos::Epetra::Epetra_IntSerialDenseVector::__call__ (   self,
  args 
)

__call__(self, int RowIndex, int ColIndex) -> int

Reimplemented from PyTrilinos::Epetra::Epetra_IntSerialDenseMatrix.

Reimplemented in PyTrilinos::Epetra::IntSerialDenseVector, and PyTrilinos::Epetra::IntSerialDenseVector.

def PyTrilinos::Epetra::Epetra_IntSerialDenseVector::__call__ (   self,
  args 
)

__call__(self, int RowIndex, int ColIndex) -> int

Reimplemented from PyTrilinos::Epetra::Epetra_IntSerialDenseMatrix.

Reimplemented in PyTrilinos::Epetra::IntSerialDenseVector, and PyTrilinos::Epetra::IntSerialDenseVector.

def PyTrilinos::Epetra::Epetra_IntSerialDenseVector::__init__ (   self,
  args 
)

__init__(self) -> Epetra_IntSerialDenseVector
__init__(self, int Length_in) -> Epetra_IntSerialDenseVector
__init__(self, Epetra_DataAccess CV_in, int Values_in, int Length_in) -> Epetra_IntSerialDenseVector
__init__(self, Epetra_IntSerialDenseVector Source) -> Epetra_IntSerialDenseVector

Epetra_IntSerialDenseVector::Epetra_IntSerialDenseVector(const
Epetra_IntSerialDenseVector &Source)

Epetra_IntSerialDenseVector copy constructor. 

Reimplemented from PyTrilinos::Epetra::Epetra_IntSerialDenseMatrix.

Reimplemented in PyTrilinos::Epetra::IntSerialDenseVector, PyTrilinos::Epetra::NumPyIntSerialDenseVector, PyTrilinos::Epetra::IntSerialDenseVector, PyTrilinos::Epetra::IntSerialDenseVector, PyTrilinos::Epetra::NumPyIntSerialDenseVector, and PyTrilinos::Epetra::IntSerialDenseVector.

def PyTrilinos::Epetra::Epetra_IntSerialDenseVector::__init__ (   self,
  args 
)

__init__(self) -> Epetra_IntSerialDenseVector
__init__(self, int Length_in) -> Epetra_IntSerialDenseVector
__init__(self, Epetra_DataAccess CV_in, int Values_in, int Length_in) -> Epetra_IntSerialDenseVector
__init__(self, Epetra_IntSerialDenseVector Source) -> Epetra_IntSerialDenseVector

Epetra_IntSerialDenseVector::Epetra_IntSerialDenseVector(const
Epetra_IntSerialDenseVector &Source)

Epetra_IntSerialDenseVector copy constructor. 

Reimplemented from PyTrilinos::Epetra::Epetra_IntSerialDenseMatrix.

Reimplemented in PyTrilinos::Epetra::IntSerialDenseVector, PyTrilinos::Epetra::NumPyIntSerialDenseVector, PyTrilinos::Epetra::IntSerialDenseVector, PyTrilinos::Epetra::IntSerialDenseVector, PyTrilinos::Epetra::NumPyIntSerialDenseVector, and PyTrilinos::Epetra::IntSerialDenseVector.

def PyTrilinos::Epetra::Epetra_IntSerialDenseVector::CV (   self  ) 

CV(self) -> Epetra_DataAccess

Epetra_DataAccess Epetra_IntSerialDenseVector::CV() const

Returns the data access mode of the this vector. 

Reimplemented from PyTrilinos::Epetra::Epetra_IntSerialDenseMatrix.

def PyTrilinos::Epetra::Epetra_IntSerialDenseVector::CV (   self  ) 

CV(self) -> Epetra_DataAccess

Epetra_DataAccess Epetra_IntSerialDenseVector::CV() const

Returns the data access mode of the this vector. 

Reimplemented from PyTrilinos::Epetra::Epetra_IntSerialDenseMatrix.

def PyTrilinos::Epetra::Epetra_IntSerialDenseVector::Length (   self  ) 

Length(self) -> int

int
Epetra_IntSerialDenseVector::Length() const

Returns length of vector. 

def PyTrilinos::Epetra::Epetra_IntSerialDenseVector::Length (   self  ) 

Length(self) -> int

int
Epetra_IntSerialDenseVector::Length() const

Returns length of vector. 

def PyTrilinos::Epetra::Epetra_IntSerialDenseVector::Random (   self  ) 

Random(self) -> int

int
Epetra_IntSerialDenseVector::Random()

Set vector values to random numbers.

IntSerialDenseVector uses the random number generator provided by
Epetra_Util. The vector values will be set to random values on the
interval (0, 2^31 - 1).

Integer error code, set to 0 if successful. 

Reimplemented from PyTrilinos::Epetra::Epetra_IntSerialDenseMatrix.

def PyTrilinos::Epetra::Epetra_IntSerialDenseVector::Random (   self  ) 

Random(self) -> int

int
Epetra_IntSerialDenseVector::Random()

Set vector values to random numbers.

IntSerialDenseVector uses the random number generator provided by
Epetra_Util. The vector values will be set to random values on the
interval (0, 2^31 - 1).

Integer error code, set to 0 if successful. 

Reimplemented from PyTrilinos::Epetra::Epetra_IntSerialDenseMatrix.

def PyTrilinos::Epetra::Epetra_IntSerialDenseVector::Resize (   self,
  args 
)

Resize(self, int Length_in) -> int

int
Epetra_IntSerialDenseVector::Resize(int Length_in)

Resize a Epetra_IntSerialDenseVector object.

Parameters:
-----------

In:  Length - Length of vector object.

Allows user to define the dimension of a Epetra_IntSerialDenseVector.
This function can be called at any point after construction. Any
values that were previously in this object are copied into the new
size. If the new shape is smaller than the original, the first Length
values are copied to the new vector.

Integer error code, set to 0 if successful. 

Reimplemented in PyTrilinos::Epetra::NumPyIntSerialDenseVector, PyTrilinos::Epetra::IntSerialDenseVector, PyTrilinos::Epetra::NumPyIntSerialDenseVector, and PyTrilinos::Epetra::IntSerialDenseVector.

def PyTrilinos::Epetra::Epetra_IntSerialDenseVector::Resize (   self,
  args 
)

Resize(self, int Length_in) -> int

int
Epetra_IntSerialDenseVector::Resize(int Length_in)

Resize a Epetra_IntSerialDenseVector object.

Parameters:
-----------

In:  Length - Length of vector object.

Allows user to define the dimension of a Epetra_IntSerialDenseVector.
This function can be called at any point after construction. Any
values that were previously in this object are copied into the new
size. If the new shape is smaller than the original, the first Length
values are copied to the new vector.

Integer error code, set to 0 if successful. 

Reimplemented in PyTrilinos::Epetra::NumPyIntSerialDenseVector, PyTrilinos::Epetra::IntSerialDenseVector, PyTrilinos::Epetra::NumPyIntSerialDenseVector, and PyTrilinos::Epetra::IntSerialDenseVector.

def PyTrilinos::Epetra::Epetra_IntSerialDenseVector::Size (   self,
  args 
)

Size(self, int Length_in) -> int

int
Epetra_IntSerialDenseVector::Size(int Length_in)

Set length of a Epetra_IntSerialDenseVector object; init values to
zero.

Parameters:
-----------

In:  Length - Length of vector object.

Allows user to define the dimension of a Epetra_IntSerialDenseVector.
This function can be called at any point after construction. Any
values that were previously in this object are destroyed and the
resized vector starts off with all zero values.

Integer error code, set to 0 if successful. 

Reimplemented in PyTrilinos::Epetra::NumPyIntSerialDenseVector, PyTrilinos::Epetra::IntSerialDenseVector, PyTrilinos::Epetra::NumPyIntSerialDenseVector, and PyTrilinos::Epetra::IntSerialDenseVector.

def PyTrilinos::Epetra::Epetra_IntSerialDenseVector::Size (   self,
  args 
)

Size(self, int Length_in) -> int

int
Epetra_IntSerialDenseVector::Size(int Length_in)

Set length of a Epetra_IntSerialDenseVector object; init values to
zero.

Parameters:
-----------

In:  Length - Length of vector object.

Allows user to define the dimension of a Epetra_IntSerialDenseVector.
This function can be called at any point after construction. Any
values that were previously in this object are destroyed and the
resized vector starts off with all zero values.

Integer error code, set to 0 if successful. 

Reimplemented in PyTrilinos::Epetra::NumPyIntSerialDenseVector, PyTrilinos::Epetra::IntSerialDenseVector, PyTrilinos::Epetra::NumPyIntSerialDenseVector, and PyTrilinos::Epetra::IntSerialDenseVector.

def PyTrilinos::Epetra::Epetra_IntSerialDenseVector::Values (   self,
  args 
)

Values(self) -> int
Values(self) -> int

const
int* Epetra_IntSerialDenseVector::Values() const

Returns const pointer to the values in vector. 

def PyTrilinos::Epetra::Epetra_IntSerialDenseVector::Values (   self,
  args 
)

Values(self) -> int
Values(self) -> int

const
int* Epetra_IntSerialDenseVector::Values() const

Returns const pointer to the values in vector. 


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

Generated on Thu Dec 17 11:00:20 2009 for PyTrilinos by  doxygen 1.5.9