PyTrilinos::Epetra::Epetra_IntSerialDenseMatrix Class Reference

Inheritance diagram for PyTrilinos::Epetra::Epetra_IntSerialDenseMatrix:

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

Collaboration graph
[legend]

List of all members.

Public Member Functions

def __init__
def Shape
def Reshape
def OneNorm
def InfNorm
def __eq__
def __ne__
def __call__
def Random
def M
def N
def A
def LDA
def CV
def __init__
def Shape
def Reshape
def OneNorm
def InfNorm
def __eq__
def __ne__
def __call__
def Random
def M
def N
def A
def LDA
def CV

Public Attributes

 this


Detailed Description

Epetra_IntSerialDenseMatrix: A class for constructing and using
general dense integer matrices.

The Epetra_IntSerialDenseMatrix class enables the construction and use
of integer-valued, general dense matrices.

The Epetra_IntSerialDenseMatrix class is intended to provide very
basic support for dense rectangular matrices.

Constructing Epetra_IntSerialDenseMatrix Objects

There are four Epetra_IntSerialDenseMatrix constructors. The first
constructs a zero-sized object which should be made to appropriate
length using the Shape() or Reshape() functions and then filled with
the [] or () operators. The second constructs an object sized to the
dimensions specified, which should be filled with the [] or ()
operators. The third is a constructor that accepts user data as a 2D
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.  Epetra_IntSerialDenseMatrix constructors will
throw an exception if an error occurrs. These exceptions will alway be
negative integer values as follows: -1 Invalid dimension specified.

-2 Shape returned non-zero.

-3 Null pointer specified for user's data.

-99 Internal Epetra_IntSerialDenseMatrix error. Contact developer.

Other Epetra_IntSerialDenseMatrix functions that do not return an
integer error code (such as operators () and [] ) will throw an
exception if an error occurrs. These exceptions will be integer values
as follows: -1 Invalid row specified.

-2 Invalid column specified.

-5 Invalid assignment (type mismatch).

-99 Internal Epetra_IntSerialDenseMatrix error. Contact developer.

b Extracting Data from Epetra_IntSerialDenseMatrix Objects

Once a Epetra_IntSerialDenseMatrix 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.  Vector and Utility Functions

Once a Epetra_IntSerialDenseMatrix is constructed, several
mathematical functions can be applied to the object. Specifically:
Multiplication.

Norms.

C++ includes: Epetra_IntSerialDenseMatrix.h 

Member Function Documentation

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

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

def PyTrilinos::Epetra::Epetra_IntSerialDenseMatrix::__eq__ (   self,
  args 
)

def PyTrilinos::Epetra::Epetra_IntSerialDenseMatrix::__eq__ (   self,
  args 
)

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

__init__(self) -> Epetra_IntSerialDenseMatrix
__init__(self, int NumRows, int NumCols) -> Epetra_IntSerialDenseMatrix
__init__(self, Epetra_DataAccess CV, int A, int LDA, int NumRows, 
    int NumCols) -> Epetra_IntSerialDenseMatrix
__init__(self, Epetra_IntSerialDenseMatrix Source) -> Epetra_IntSerialDenseMatrix

Epetra_IntSerialDenseMatrix::Epetra_IntSerialDenseMatrix(const
Epetra_IntSerialDenseMatrix &Source)

Epetra_IntSerialDenseMatrix copy constructor.

This matrix will take on the data access mode of the Source matrix. 

Reimplemented from PyTrilinos::Epetra::Object.

Reimplemented in PyTrilinos::Epetra::IntSerialDenseMatrix, PyTrilinos::Epetra::IntSerialDenseVector, PyTrilinos::Epetra::Epetra_IntSerialDenseVector, PyTrilinos::Epetra::NumPyIntSerialDenseMatrix, PyTrilinos::Epetra::IntSerialDenseMatrix, PyTrilinos::Epetra::NumPyIntSerialDenseVector, PyTrilinos::Epetra::IntSerialDenseVector, PyTrilinos::Epetra::IntSerialDenseMatrix, PyTrilinos::Epetra::IntSerialDenseVector, PyTrilinos::Epetra::Epetra_IntSerialDenseVector, PyTrilinos::Epetra::NumPyIntSerialDenseMatrix, PyTrilinos::Epetra::IntSerialDenseMatrix, PyTrilinos::Epetra::NumPyIntSerialDenseVector, and PyTrilinos::Epetra::IntSerialDenseVector.

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

__init__(self) -> Epetra_IntSerialDenseMatrix
__init__(self, int NumRows, int NumCols) -> Epetra_IntSerialDenseMatrix
__init__(self, Epetra_DataAccess CV, int A, int LDA, int NumRows, 
    int NumCols) -> Epetra_IntSerialDenseMatrix
__init__(self, Epetra_IntSerialDenseMatrix Source) -> Epetra_IntSerialDenseMatrix

Epetra_IntSerialDenseMatrix::Epetra_IntSerialDenseMatrix(const
Epetra_IntSerialDenseMatrix &Source)

Epetra_IntSerialDenseMatrix copy constructor.

This matrix will take on the data access mode of the Source matrix. 

Reimplemented from PyTrilinos::Epetra::Object.

Reimplemented in PyTrilinos::Epetra::IntSerialDenseMatrix, PyTrilinos::Epetra::IntSerialDenseVector, PyTrilinos::Epetra::Epetra_IntSerialDenseVector, PyTrilinos::Epetra::NumPyIntSerialDenseMatrix, PyTrilinos::Epetra::IntSerialDenseMatrix, PyTrilinos::Epetra::NumPyIntSerialDenseVector, PyTrilinos::Epetra::IntSerialDenseVector, PyTrilinos::Epetra::IntSerialDenseMatrix, PyTrilinos::Epetra::IntSerialDenseVector, PyTrilinos::Epetra::Epetra_IntSerialDenseVector, PyTrilinos::Epetra::NumPyIntSerialDenseMatrix, PyTrilinos::Epetra::IntSerialDenseMatrix, PyTrilinos::Epetra::NumPyIntSerialDenseVector, and PyTrilinos::Epetra::IntSerialDenseVector.

def PyTrilinos::Epetra::Epetra_IntSerialDenseMatrix::__ne__ (   self,
  args 
)

def PyTrilinos::Epetra::Epetra_IntSerialDenseMatrix::__ne__ (   self,
  args 
)

def PyTrilinos::Epetra::Epetra_IntSerialDenseMatrix::A (   self  ) 

A(self) -> int

int*
Epetra_IntSerialDenseMatrix::A()

Returns pointer to the this matrix. 

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

def PyTrilinos::Epetra::Epetra_IntSerialDenseMatrix::A (   self  ) 

A(self) -> int

int*
Epetra_IntSerialDenseMatrix::A()

Returns pointer to the this matrix. 

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

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

CV(self) -> Epetra_DataAccess

Epetra_DataAccess Epetra_IntSerialDenseMatrix::CV() const

Returns the data access mode of the this matrix. 

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

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

CV(self) -> Epetra_DataAccess

Epetra_DataAccess Epetra_IntSerialDenseMatrix::CV() const

Returns the data access mode of the this matrix. 

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

def PyTrilinos::Epetra::Epetra_IntSerialDenseMatrix::InfNorm (   self  ) 

InfNorm(self) -> int

int
Epetra_IntSerialDenseMatrix::InfNorm()

Computes the Infinity-Norm of the this matrix. 

def PyTrilinos::Epetra::Epetra_IntSerialDenseMatrix::InfNorm (   self  ) 

InfNorm(self) -> int

int
Epetra_IntSerialDenseMatrix::InfNorm()

Computes the Infinity-Norm of the this matrix. 

def PyTrilinos::Epetra::Epetra_IntSerialDenseMatrix::LDA (   self  ) 

LDA(self) -> int

int
Epetra_IntSerialDenseMatrix::LDA() const

Returns the leading dimension of the this matrix. 

def PyTrilinos::Epetra::Epetra_IntSerialDenseMatrix::LDA (   self  ) 

LDA(self) -> int

int
Epetra_IntSerialDenseMatrix::LDA() const

Returns the leading dimension of the this matrix. 

def PyTrilinos::Epetra::Epetra_IntSerialDenseMatrix::M (   self  ) 

M(self) -> int

int
Epetra_IntSerialDenseMatrix::M() const

Returns row dimension of system. 

def PyTrilinos::Epetra::Epetra_IntSerialDenseMatrix::M (   self  ) 

M(self) -> int

int
Epetra_IntSerialDenseMatrix::M() const

Returns row dimension of system. 

def PyTrilinos::Epetra::Epetra_IntSerialDenseMatrix::N (   self  ) 

N(self) -> int

int
Epetra_IntSerialDenseMatrix::N() const

Returns column dimension of system. 

def PyTrilinos::Epetra::Epetra_IntSerialDenseMatrix::N (   self  ) 

N(self) -> int

int
Epetra_IntSerialDenseMatrix::N() const

Returns column dimension of system. 

def PyTrilinos::Epetra::Epetra_IntSerialDenseMatrix::OneNorm (   self  ) 

OneNorm(self) -> int

int
Epetra_IntSerialDenseMatrix::OneNorm()

Computes the 1-Norm of the this matrix.

Integer error code, set to 0 if successful. 

def PyTrilinos::Epetra::Epetra_IntSerialDenseMatrix::OneNorm (   self  ) 

OneNorm(self) -> int

int
Epetra_IntSerialDenseMatrix::OneNorm()

Computes the 1-Norm of the this matrix.

Integer error code, set to 0 if successful. 

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

Random(self) -> int

int
Epetra_IntSerialDenseMatrix::Random()

Set matrix values to random numbers.

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

Integer error code, set to 0 if successful. 

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

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

Random(self) -> int

int
Epetra_IntSerialDenseMatrix::Random()

Set matrix values to random numbers.

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

Integer error code, set to 0 if successful. 

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

def PyTrilinos::Epetra::Epetra_IntSerialDenseMatrix::Reshape (   self,
  args 
)

Reshape(self, int NumRows, int NumCols) -> int

int
Epetra_IntSerialDenseMatrix::Reshape(int NumRows, int NumCols)

Reshape a Epetra_IntSerialDenseMatrix object.

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

In:  NumRows - Number of rows in object.

In:  NumCols - Number of columns in object.

Allows user to define the dimensions of a Epetra_IntSerialDenseMatrix
at any point. This function can be called at any point after
construction. Any values that were previously in this object are
copied into the new shape. If the new shape is smaller than the
original, the upper left portion of the original matrix (the principal
submatrix) is copied to the new matrix.

Integer error code, set to 0 if successful. 

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

def PyTrilinos::Epetra::Epetra_IntSerialDenseMatrix::Reshape (   self,
  args 
)

Reshape(self, int NumRows, int NumCols) -> int

int
Epetra_IntSerialDenseMatrix::Reshape(int NumRows, int NumCols)

Reshape a Epetra_IntSerialDenseMatrix object.

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

In:  NumRows - Number of rows in object.

In:  NumCols - Number of columns in object.

Allows user to define the dimensions of a Epetra_IntSerialDenseMatrix
at any point. This function can be called at any point after
construction. Any values that were previously in this object are
copied into the new shape. If the new shape is smaller than the
original, the upper left portion of the original matrix (the principal
submatrix) is copied to the new matrix.

Integer error code, set to 0 if successful. 

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

def PyTrilinos::Epetra::Epetra_IntSerialDenseMatrix::Shape (   self,
  args 
)

Shape(self, int NumRows, int NumCols) -> int

int
Epetra_IntSerialDenseMatrix::Shape(int NumRows, int NumCols)

Set dimensions of a Epetra_IntSerialDenseMatrix object; init values to
zero.

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

In:  NumRows - Number of rows in object.

In:  NumCols - Number of columns in object.

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

Integer error code, set to 0 if successful. 

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

def PyTrilinos::Epetra::Epetra_IntSerialDenseMatrix::Shape (   self,
  args 
)

Shape(self, int NumRows, int NumCols) -> int

int
Epetra_IntSerialDenseMatrix::Shape(int NumRows, int NumCols)

Set dimensions of a Epetra_IntSerialDenseMatrix object; init values to
zero.

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

In:  NumRows - Number of rows in object.

In:  NumCols - Number of columns in object.

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

Integer error code, set to 0 if successful. 

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


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