vtkDiagonalMatrixSource Class Reference

generates a sparse or dense square matrix with user-specified values for the diagonal, superdiagonal, and subdiagonal. More...

#include <vtkDiagonalMatrixSource.h>

Inheritance diagram for vtkDiagonalMatrixSource:

Collaboration diagram for vtkDiagonalMatrixSource:

List of all members.

Public Types
enum	StorageType { DENSE, SPARSE }
typedef vtkArrayDataAlgorithm	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkDiagonalMatrixSource *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual int	GetArrayType ()
virtual void	SetArrayType (int)
virtual vtkIdType	GetExtents ()
virtual void	SetExtents (vtkIdType)
virtual double	GetDiagonal ()
virtual void	SetDiagonal (double)
virtual double	GetSuperDiagonal ()
virtual void	SetSuperDiagonal (double)
virtual double	GetSubDiagonal ()
virtual void	SetSubDiagonal (double)
virtual char *	GetRowLabel ()
virtual void	SetRowLabel (const char *)
virtual char *	GetColumnLabel ()
virtual void	SetColumnLabel (const char *)
Static Public Member Functions
static vtkDiagonalMatrixSource *	New ()
static int	IsTypeOf (const char *type)
static vtkDiagonalMatrixSource *	SafeDownCast (vtkObjectBase *o)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkDiagonalMatrixSource ()
	~vtkDiagonalMatrixSource ()
int	RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)

---

Detailed Description

generates a sparse or dense square matrix with user-specified values for the diagonal, superdiagonal, and subdiagonal.

Thanks:

Developed by Timothy M. Shead (tshea.nosp@m.d@sa.nosp@m.ndia..nosp@m.gov) at Sandia National Laboratories.

Examples:

vtkDiagonalMatrixSource (Examples)

Tests:

vtkDiagonalMatrixSource (Tests)

Definition at line 42 of file vtkDiagonalMatrixSource.h.

---

Member Typedef Documentation

typedef vtkArrayDataAlgorithm vtkDiagonalMatrixSource::Superclass

Reimplemented from vtkArrayDataAlgorithm.

Definition at line 46 of file vtkDiagonalMatrixSource.h.

---

Member Enumeration Documentation

enum vtkDiagonalMatrixSource::StorageType

Enumerator:

DENSE
SPARSE

Definition at line 51 of file vtkDiagonalMatrixSource.h.

---

Constructor & Destructor Documentation

vtkDiagonalMatrixSource::vtkDiagonalMatrixSource

(

)

[protected]

vtkDiagonalMatrixSource::~vtkDiagonalMatrixSource

(

)

[protected]

---

Member Function Documentation

static vtkDiagonalMatrixSource* vtkDiagonalMatrixSource::New

(

)

[static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkArrayDataAlgorithm.

static int vtkDiagonalMatrixSource::IsTypeOf

(

const char *

name

)

[static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkArrayDataAlgorithm.

virtual int vtkDiagonalMatrixSource::IsA

(

const char *

name

)

[virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkArrayDataAlgorithm.

static vtkDiagonalMatrixSource* vtkDiagonalMatrixSource::SafeDownCast

(

vtkObjectBase *

o

)

[static]

Reimplemented from vtkArrayDataAlgorithm.

virtual vtkObjectBase* vtkDiagonalMatrixSource::NewInstanceInternal

(

)

const [protected, virtual]

Reimplemented from vtkArrayDataAlgorithm.

vtkDiagonalMatrixSource* vtkDiagonalMatrixSource::NewInstance

(

)

const

Reimplemented from vtkArrayDataAlgorithm.

void vtkDiagonalMatrixSource::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		[virtual]

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkArrayDataAlgorithm.

virtual int vtkDiagonalMatrixSource::GetArrayType

(

)

[virtual]

virtual void vtkDiagonalMatrixSource::SetArrayType

(

int

)

[virtual]

virtual vtkIdType vtkDiagonalMatrixSource::GetExtents

(

)

[virtual]

Stores the extents of the output matrix (which is square)

virtual void vtkDiagonalMatrixSource::SetExtents

(

vtkIdType

)

[virtual]

Stores the extents of the output matrix (which is square)

virtual double vtkDiagonalMatrixSource::GetDiagonal

(

)

[virtual]

Stores the value that will be assigned to diagonal elements (default: 1)

virtual void vtkDiagonalMatrixSource::SetDiagonal

(

double

)

[virtual]

Stores the value that will be assigned to diagonal elements (default: 1)

virtual double vtkDiagonalMatrixSource::GetSuperDiagonal

(

)

[virtual]

Stores the value that will be assigned to superdiagonal elements (default: 0)

virtual void vtkDiagonalMatrixSource::SetSuperDiagonal

(

double

)

[virtual]

Stores the value that will be assigned to superdiagonal elements (default: 0)

virtual double vtkDiagonalMatrixSource::GetSubDiagonal

(

)

[virtual]

Stores the value that will be assigned to subdiagonal elements (default: 0)

virtual void vtkDiagonalMatrixSource::SetSubDiagonal

(

double

)

[virtual]

Stores the value that will be assigned to subdiagonal elements (default: 0)

virtual char* vtkDiagonalMatrixSource::GetRowLabel

(

)

[virtual]

Controls the output matrix row dimension label. Default: "rows"

virtual void vtkDiagonalMatrixSource::SetRowLabel

(

const char *

)

[virtual]

Controls the output matrix row dimension label. Default: "rows"

virtual char* vtkDiagonalMatrixSource::GetColumnLabel

(

)

[virtual]

Controls the output matrix column dimension label. Default: "columns"

virtual void vtkDiagonalMatrixSource::SetColumnLabel

(

const char *

)

[virtual]

Controls the output matrix column dimension label. Default: "columns"

int vtkDiagonalMatrixSource::RequestData	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)		[protected, virtual]

This is called by the superclass. This is the method you should override.

Reimplemented from vtkArrayDataAlgorithm.

---

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

• dox/Filters/Sources/vtkDiagonalMatrixSource.h