PyTrilinos::Epetra::Epetra_SerialDenseVector Class Reference

Inheritance diagram for PyTrilinos::Epetra::Epetra_SerialDenseVector:

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

Collaboration graph
[legend]

List of all members.

Public Member Functions

def __init__
def Size
def Resize
def __call__
def Random
def Dot
def Norm1
def Norm2
def NormInf
def Length
def Values
def CV
def __init__
def Size
def Resize
def __call__
def Random
def Dot
def Norm1
def Norm2
def NormInf
def Length
def Values
def CV

Public Attributes

 this


Detailed Description

Epetra_SerialDenseVector: A class for constructing and using dense
vectors.

The Epetra_SerialDenseVector class enables the construction and use of
real-valued, double- precision dense vectors. It is built on the BLAS
and LAPACK and derives from the Epetra_SerialDenseMatrix class.

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

Constructing Epetra_SerialDenseVector Objects

There are four Epetra_SerialDenseVector 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_SerialDenseVector
Objects

Once a Epetra_SerialDenseVector 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.  The final useful function is Flops().
Each Epetra_SerialDenseVector object keep track of the number of
serial floating point operations performed using the specified object
as the this argument to the function. The Flops() function returns
this number as a double precision number. Using this information, in
conjunction with the Epetra_Time class, one can get accurate parallel
performance numbers.

C++ includes: Epetra_SerialDenseVector.h 

Member Function Documentation

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

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

Reimplemented from PyTrilinos::Epetra::Epetra_SerialDenseMatrix.

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

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

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

Reimplemented from PyTrilinos::Epetra::Epetra_SerialDenseMatrix.

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

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

__init__(self) -> Epetra_SerialDenseVector
__init__(self, int Length) -> Epetra_SerialDenseVector
__init__(self, Epetra_DataAccess CV, double Values, int Length) -> Epetra_SerialDenseVector
__init__(self, Epetra_SerialDenseVector Source) -> Epetra_SerialDenseVector

Epetra_SerialDenseVector::Epetra_SerialDenseVector(const
Epetra_SerialDenseVector &Source)

Epetra_SerialDenseVector copy constructor. 

Reimplemented from PyTrilinos::Epetra::Epetra_SerialDenseMatrix.

Reimplemented in PyTrilinos::Epetra::SerialDenseVector, PyTrilinos::Epetra::NumPySerialDenseVector, PyTrilinos::Epetra::SerialDenseVector, PyTrilinos::Epetra::SerialDenseVector, PyTrilinos::Epetra::NumPySerialDenseVector, and PyTrilinos::Epetra::SerialDenseVector.

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

__init__(self) -> Epetra_SerialDenseVector
__init__(self, int Length) -> Epetra_SerialDenseVector
__init__(self, Epetra_DataAccess CV, double Values, int Length) -> Epetra_SerialDenseVector
__init__(self, Epetra_SerialDenseVector Source) -> Epetra_SerialDenseVector

Epetra_SerialDenseVector::Epetra_SerialDenseVector(const
Epetra_SerialDenseVector &Source)

Epetra_SerialDenseVector copy constructor. 

Reimplemented from PyTrilinos::Epetra::Epetra_SerialDenseMatrix.

Reimplemented in PyTrilinos::Epetra::SerialDenseVector, PyTrilinos::Epetra::NumPySerialDenseVector, PyTrilinos::Epetra::SerialDenseVector, PyTrilinos::Epetra::SerialDenseVector, PyTrilinos::Epetra::NumPySerialDenseVector, and PyTrilinos::Epetra::SerialDenseVector.

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

CV(self) -> Epetra_DataAccess

Epetra_DataAccess Epetra_SerialDenseVector::CV() const

Returns the data access mode of the this vector. 

Reimplemented from PyTrilinos::Epetra::Epetra_SerialDenseMatrix.

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

CV(self) -> Epetra_DataAccess

Epetra_DataAccess Epetra_SerialDenseVector::CV() const

Returns the data access mode of the this vector. 

Reimplemented from PyTrilinos::Epetra::Epetra_SerialDenseMatrix.

def PyTrilinos::Epetra::Epetra_SerialDenseVector::Dot (   self,
  args 
)

Dot(self, Epetra_SerialDenseVector x) -> double

double
Epetra_SerialDenseVector::Dot(const Epetra_SerialDenseVector &x) const

Compute 1-norm of each vector in multi-vector.

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

x:  (In) Input vector x.

Dot-product of the this vector and x. 

def PyTrilinos::Epetra::Epetra_SerialDenseVector::Dot (   self,
  args 
)

Dot(self, Epetra_SerialDenseVector x) -> double

double
Epetra_SerialDenseVector::Dot(const Epetra_SerialDenseVector &x) const

Compute 1-norm of each vector in multi-vector.

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

x:  (In) Input vector x.

Dot-product of the this vector and x. 

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

Length(self) -> int

int
Epetra_SerialDenseVector::Length() const

Returns length of vector. 

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

Length(self) -> int

int
Epetra_SerialDenseVector::Length() const

Returns length of vector. 

def PyTrilinos::Epetra::Epetra_SerialDenseVector::Norm1 (   self  ) 

Norm1(self) -> double

double
Epetra_SerialDenseVector::Norm1() const

Compute 1-norm of each vector in multi-vector.

1-norm of the vector. 

def PyTrilinos::Epetra::Epetra_SerialDenseVector::Norm1 (   self  ) 

Norm1(self) -> double

double
Epetra_SerialDenseVector::Norm1() const

Compute 1-norm of each vector in multi-vector.

1-norm of the vector. 

def PyTrilinos::Epetra::Epetra_SerialDenseVector::Norm2 (   self  ) 

Norm2(self) -> double

double
Epetra_SerialDenseVector::Norm2() const

Compute 2-norm of each vector in multi-vector.

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

Out:

2-norm of the vector. 

def PyTrilinos::Epetra::Epetra_SerialDenseVector::Norm2 (   self  ) 

Norm2(self) -> double

double
Epetra_SerialDenseVector::Norm2() const

Compute 2-norm of each vector in multi-vector.

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

Out:

2-norm of the vector. 

def PyTrilinos::Epetra::Epetra_SerialDenseVector::NormInf (   self  ) 

NormInf(self) -> double

double
Epetra_SerialDenseVector::NormInf() const

Compute Inf-norm of each vector in multi-vector.

Infinity-norm of the vector. 

Reimplemented from PyTrilinos::Epetra::Epetra_SerialDenseMatrix.

def PyTrilinos::Epetra::Epetra_SerialDenseVector::NormInf (   self  ) 

NormInf(self) -> double

double
Epetra_SerialDenseVector::NormInf() const

Compute Inf-norm of each vector in multi-vector.

Infinity-norm of the vector. 

Reimplemented from PyTrilinos::Epetra::Epetra_SerialDenseMatrix.

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

Random(self) -> int

int
Epetra_SerialDenseVector::Random()

Set vector values to random numbers.

SerialDenseVector uses the random number generator provided by
Epetra_Util. The vector values will be set to random values on the
interval (-1.0, 1.0).

Integer error code, set to 0 if successful. 

Reimplemented from PyTrilinos::Epetra::Epetra_SerialDenseMatrix.

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

Random(self) -> int

int
Epetra_SerialDenseVector::Random()

Set vector values to random numbers.

SerialDenseVector uses the random number generator provided by
Epetra_Util. The vector values will be set to random values on the
interval (-1.0, 1.0).

Integer error code, set to 0 if successful. 

Reimplemented from PyTrilinos::Epetra::Epetra_SerialDenseMatrix.

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

Resize(self, int Length_in) -> int

int
Epetra_SerialDenseVector::Resize(int Length_in)

Resize a Epetra_SerialDenseVector object.

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

In:  Length - Length of vector object.

Allows user to define the dimension of a Epetra_SerialDenseVector.
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::NumPySerialDenseVector, PyTrilinos::Epetra::SerialDenseVector, PyTrilinos::Epetra::NumPySerialDenseVector, and PyTrilinos::Epetra::SerialDenseVector.

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

Resize(self, int Length_in) -> int

int
Epetra_SerialDenseVector::Resize(int Length_in)

Resize a Epetra_SerialDenseVector object.

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

In:  Length - Length of vector object.

Allows user to define the dimension of a Epetra_SerialDenseVector.
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::NumPySerialDenseVector, PyTrilinos::Epetra::SerialDenseVector, PyTrilinos::Epetra::NumPySerialDenseVector, and PyTrilinos::Epetra::SerialDenseVector.

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

Size(self, int Length_in) -> int

int
Epetra_SerialDenseVector::Size(int Length_in)

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

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

In:  Length - Length of vector object.

Allows user to define the dimension of a Epetra_SerialDenseVector.
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::NumPySerialDenseVector, PyTrilinos::Epetra::SerialDenseVector, PyTrilinos::Epetra::NumPySerialDenseVector, and PyTrilinos::Epetra::SerialDenseVector.

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

Size(self, int Length_in) -> int

int
Epetra_SerialDenseVector::Size(int Length_in)

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

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

In:  Length - Length of vector object.

Allows user to define the dimension of a Epetra_SerialDenseVector.
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::NumPySerialDenseVector, PyTrilinos::Epetra::SerialDenseVector, PyTrilinos::Epetra::NumPySerialDenseVector, and PyTrilinos::Epetra::SerialDenseVector.

def PyTrilinos::Epetra::Epetra_SerialDenseVector::Values (   self  ) 

Values(self) -> double

double*
Epetra_SerialDenseVector::Values() const

Returns pointer to the values in vector. 

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

def PyTrilinos::Epetra::Epetra_SerialDenseVector::Values (   self  ) 

Values(self) -> double

double*
Epetra_SerialDenseVector::Values() const

Returns pointer to the values in vector. 

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


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