Stokhos Package Browser (Single Doxygen Collection): Stokhos::FlatSparse3Tensor< ValueType, ExecutionSpace > Class Template Reference

Stokhos Package Browser (Single Doxygen Collection) Version of the Day

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages

Sparse product tensor with replicated entries to provide subsets with a given coordinate. More...

#include <Stokhos_FlatSparse3Tensor.hpp>

Public Types
typedef ExecutionSpace	execution_space

typedef execution_space::size_type	size_type

typedef ValueType	value_type

Public Member Functions
	~FlatSparse3Tensor ()

	FlatSparse3Tensor ()

	FlatSparse3Tensor (const FlatSparse3Tensor &rhs)

FlatSparse3Tensor &	operator= (const FlatSparse3Tensor &rhs)

KOKKOS_INLINE_FUNCTION size_type	dimension () const
	Dimension of the tensor. More...

KOKKOS_INLINE_FUNCTION size_type	entry_count () const
	Number of sparse entries. More...

KOKKOS_INLINE_FUNCTION size_type	k_begin (size_type i) const
	Begin k entries with a coordinate 'i'. More...

KOKKOS_INLINE_FUNCTION size_type	k_end (size_type i) const
	End k entries with a coordinate 'i'. More...

KOKKOS_INLINE_FUNCTION size_type	num_k (size_type i) const
	Number of k entries with a coordinate 'i'. More...

KOKKOS_INLINE_FUNCTION const size_type &	k_coord (const size_type kEntry) const
	k coordinate for k entry 'kEntry' More...

KOKKOS_INLINE_FUNCTION size_type	j_begin (size_type kEntry) const
	Begin j entries with a k entry 'kEntry'. More...

KOKKOS_INLINE_FUNCTION size_type	j_end (size_type kEntry) const
	End j entries with a k entry 'kEntry'. More...

KOKKOS_INLINE_FUNCTION size_type	num_j (size_type kEntry) const
	Number of j entries with a k entry 'kEntry'. More...

KOKKOS_INLINE_FUNCTION const size_type &	j_coord (const size_type jEntry) const
	j coordinate for j entry 'jEntry' More...

KOKKOS_INLINE_FUNCTION const value_type &	value (const size_type jEntry) const
	Value for j entry 'jEntry'. More...

KOKKOS_INLINE_FUNCTION size_type	num_non_zeros () const
	Number of non-zero's. More...

KOKKOS_INLINE_FUNCTION size_type	num_flops () const
	Number flop's per multiply-add. More...

Static Public Member Functions
template<typename OrdinalType >
static FlatSparse3Tensor	create (const Stokhos::ProductBasis< OrdinalType, ValueType > &basis, const Stokhos::Sparse3Tensor< OrdinalType, ValueType > &Cijk, const Teuchos::ParameterList &params=Teuchos::ParameterList())

Private Types
typedef Kokkos::View < size_type[], execution_space >	coord_array_type

typedef Kokkos::View < value_type[], execution_space >	value_array_type

typedef Kokkos::View < size_type[], execution_space >	entry_array_type

typedef Kokkos::View < size_type[], execution_space >	row_map_array_type

Private Attributes
coord_array_type	m_k_coord

coord_array_type	m_j_coord

value_array_type	m_value

entry_array_type	m_num_k

entry_array_type	m_num_j

row_map_array_type	m_k_row_map

row_map_array_type	m_j_row_map

size_type	m_nnz

size_type	m_flops

Detailed Description

template<typename ValueType, class ExecutionSpace>
class Stokhos::FlatSparse3Tensor< ValueType, ExecutionSpace >

Sparse product tensor with replicated entries to provide subsets with a given coordinate.

Definition at line 62 of file Stokhos_FlatSparse3Tensor.hpp.

Member Typedef Documentation

template<typename ValueType , class ExecutionSpace >

typedef ExecutionSpace Stokhos::FlatSparse3Tensor< ValueType, ExecutionSpace >::execution_space

Definition at line 65 of file Stokhos_FlatSparse3Tensor.hpp.

template<typename ValueType , class ExecutionSpace >

typedef execution_space::size_type Stokhos::FlatSparse3Tensor< ValueType, ExecutionSpace >::size_type

Definition at line 66 of file Stokhos_FlatSparse3Tensor.hpp.

template<typename ValueType , class ExecutionSpace >

typedef ValueType Stokhos::FlatSparse3Tensor< ValueType, ExecutionSpace >::value_type

Definition at line 67 of file Stokhos_FlatSparse3Tensor.hpp.

template<typename ValueType , class ExecutionSpace >

typedef Kokkos::View< size_type[] , execution_space > Stokhos::FlatSparse3Tensor< ValueType, ExecutionSpace >::coord_array_type

private

Definition at line 71 of file Stokhos_FlatSparse3Tensor.hpp.

template<typename ValueType , class ExecutionSpace >

typedef Kokkos::View< value_type[], execution_space > Stokhos::FlatSparse3Tensor< ValueType, ExecutionSpace >::value_array_type

private

Definition at line 72 of file Stokhos_FlatSparse3Tensor.hpp.

template<typename ValueType , class ExecutionSpace >

typedef Kokkos::View< size_type[], execution_space > Stokhos::FlatSparse3Tensor< ValueType, ExecutionSpace >::entry_array_type

private

Definition at line 73 of file Stokhos_FlatSparse3Tensor.hpp.

template<typename ValueType , class ExecutionSpace >

typedef Kokkos::View< size_type[], execution_space > Stokhos::FlatSparse3Tensor< ValueType, ExecutionSpace >::row_map_array_type

private

Definition at line 74 of file Stokhos_FlatSparse3Tensor.hpp.

Constructor & Destructor Documentation

template<typename ValueType , class ExecutionSpace >

Stokhos::FlatSparse3Tensor< ValueType, ExecutionSpace >::~FlatSparse3Tensor ( )

inline

Definition at line 89 of file Stokhos_FlatSparse3Tensor.hpp.

template<typename ValueType , class ExecutionSpace >

Stokhos::FlatSparse3Tensor< ValueType, ExecutionSpace >::FlatSparse3Tensor ( )

inline

Definition at line 92 of file Stokhos_FlatSparse3Tensor.hpp.

template<typename ValueType , class ExecutionSpace >

Stokhos::FlatSparse3Tensor< ValueType, ExecutionSpace >::FlatSparse3Tensor ( const FlatSparse3Tensor< ValueType, ExecutionSpace > & rhs )

inline

Definition at line 104 of file Stokhos_FlatSparse3Tensor.hpp.

Member Function Documentation

template<typename ValueType , class ExecutionSpace >

FlatSparse3Tensor& Stokhos::FlatSparse3Tensor< ValueType, ExecutionSpace >::operator= ( const FlatSparse3Tensor< ValueType, ExecutionSpace > & rhs )

inline

Definition at line 116 of file Stokhos_FlatSparse3Tensor.hpp.

template<typename ValueType , class ExecutionSpace >

KOKKOS_INLINE_FUNCTION size_type Stokhos::FlatSparse3Tensor< ValueType, ExecutionSpace >::dimension ( ) const

inline

Dimension of the tensor.

Definition at line 132 of file Stokhos_FlatSparse3Tensor.hpp.

template<typename ValueType , class ExecutionSpace >

KOKKOS_INLINE_FUNCTION size_type Stokhos::FlatSparse3Tensor< ValueType, ExecutionSpace >::entry_count ( ) const

inline

Number of sparse entries.

Definition at line 136 of file Stokhos_FlatSparse3Tensor.hpp.

template<typename ValueType , class ExecutionSpace >

KOKKOS_INLINE_FUNCTION size_type Stokhos::FlatSparse3Tensor< ValueType, ExecutionSpace >::k_begin ( size_type i ) const

inline

Begin k entries with a coordinate 'i'.

Definition at line 141 of file Stokhos_FlatSparse3Tensor.hpp.

template<typename ValueType , class ExecutionSpace >

KOKKOS_INLINE_FUNCTION size_type Stokhos::FlatSparse3Tensor< ValueType, ExecutionSpace >::k_end ( size_type i ) const

inline

End k entries with a coordinate 'i'.

Definition at line 146 of file Stokhos_FlatSparse3Tensor.hpp.

template<typename ValueType , class ExecutionSpace >

KOKKOS_INLINE_FUNCTION size_type Stokhos::FlatSparse3Tensor< ValueType, ExecutionSpace >::num_k ( size_type i ) const

inline

Number of k entries with a coordinate 'i'.

Definition at line 151 of file Stokhos_FlatSparse3Tensor.hpp.

template<typename ValueType , class ExecutionSpace >

KOKKOS_INLINE_FUNCTION const size_type& Stokhos::FlatSparse3Tensor< ValueType, ExecutionSpace >::k_coord ( const size_type kEntry ) const

inline

k coordinate for k entry 'kEntry'

Definition at line 156 of file Stokhos_FlatSparse3Tensor.hpp.

template<typename ValueType , class ExecutionSpace >

KOKKOS_INLINE_FUNCTION size_type Stokhos::FlatSparse3Tensor< ValueType, ExecutionSpace >::j_begin ( size_type kEntry ) const

inline

Begin j entries with a k entry 'kEntry'.

Definition at line 161 of file Stokhos_FlatSparse3Tensor.hpp.

template<typename ValueType , class ExecutionSpace >

KOKKOS_INLINE_FUNCTION size_type Stokhos::FlatSparse3Tensor< ValueType, ExecutionSpace >::j_end ( size_type kEntry ) const

inline

End j entries with a k entry 'kEntry'.

Definition at line 166 of file Stokhos_FlatSparse3Tensor.hpp.

template<typename ValueType , class ExecutionSpace >

KOKKOS_INLINE_FUNCTION size_type Stokhos::FlatSparse3Tensor< ValueType, ExecutionSpace >::num_j ( size_type kEntry ) const

inline

Number of j entries with a k entry 'kEntry'.

Definition at line 171 of file Stokhos_FlatSparse3Tensor.hpp.

template<typename ValueType , class ExecutionSpace >

KOKKOS_INLINE_FUNCTION const size_type& Stokhos::FlatSparse3Tensor< ValueType, ExecutionSpace >::j_coord ( const size_type jEntry ) const

inline

j coordinate for j entry 'jEntry'

Definition at line 176 of file Stokhos_FlatSparse3Tensor.hpp.

template<typename ValueType , class ExecutionSpace >

KOKKOS_INLINE_FUNCTION const value_type& Stokhos::FlatSparse3Tensor< ValueType, ExecutionSpace >::value ( const size_type jEntry ) const

inline

Value for j entry 'jEntry'.

Definition at line 181 of file Stokhos_FlatSparse3Tensor.hpp.

template<typename ValueType , class ExecutionSpace >

KOKKOS_INLINE_FUNCTION size_type Stokhos::FlatSparse3Tensor< ValueType, ExecutionSpace >::num_non_zeros ( ) const

inline

Number of non-zero's.

Definition at line 186 of file Stokhos_FlatSparse3Tensor.hpp.

template<typename ValueType , class ExecutionSpace >

KOKKOS_INLINE_FUNCTION size_type Stokhos::FlatSparse3Tensor< ValueType, ExecutionSpace >::num_flops ( ) const

inline

Number flop's per multiply-add.

Definition at line 191 of file Stokhos_FlatSparse3Tensor.hpp.

template<typename ValueType , class ExecutionSpace >

template<typename OrdinalType >

static FlatSparse3Tensor Stokhos::FlatSparse3Tensor< ValueType, ExecutionSpace >::create	(	const Stokhos::ProductBasis< OrdinalType, ValueType > &	basis,
		const Stokhos::Sparse3Tensor< OrdinalType, ValueType > &	Cijk,
		const Teuchos::ParameterList &	params = `Teuchos::ParameterList()`
	)

inlinestatic

Definition at line 196 of file Stokhos_FlatSparse3Tensor.hpp.

Member Data Documentation

template<typename ValueType , class ExecutionSpace >

coord_array_type Stokhos::FlatSparse3Tensor< ValueType, ExecutionSpace >::m_k_coord

private

Definition at line 76 of file Stokhos_FlatSparse3Tensor.hpp.

template<typename ValueType , class ExecutionSpace >

coord_array_type Stokhos::FlatSparse3Tensor< ValueType, ExecutionSpace >::m_j_coord

private

Definition at line 77 of file Stokhos_FlatSparse3Tensor.hpp.

template<typename ValueType , class ExecutionSpace >

value_array_type Stokhos::FlatSparse3Tensor< ValueType, ExecutionSpace >::m_value

private

Definition at line 78 of file Stokhos_FlatSparse3Tensor.hpp.

template<typename ValueType , class ExecutionSpace >

entry_array_type Stokhos::FlatSparse3Tensor< ValueType, ExecutionSpace >::m_num_k

private

Definition at line 79 of file Stokhos_FlatSparse3Tensor.hpp.

template<typename ValueType , class ExecutionSpace >

entry_array_type Stokhos::FlatSparse3Tensor< ValueType, ExecutionSpace >::m_num_j

private

Definition at line 80 of file Stokhos_FlatSparse3Tensor.hpp.

template<typename ValueType , class ExecutionSpace >

row_map_array_type Stokhos::FlatSparse3Tensor< ValueType, ExecutionSpace >::m_k_row_map

private

Definition at line 81 of file Stokhos_FlatSparse3Tensor.hpp.

template<typename ValueType , class ExecutionSpace >

row_map_array_type Stokhos::FlatSparse3Tensor< ValueType, ExecutionSpace >::m_j_row_map

private

Definition at line 82 of file Stokhos_FlatSparse3Tensor.hpp.

template<typename ValueType , class ExecutionSpace >

size_type Stokhos::FlatSparse3Tensor< ValueType, ExecutionSpace >::m_nnz

private

Definition at line 83 of file Stokhos_FlatSparse3Tensor.hpp.

template<typename ValueType , class ExecutionSpace >

size_type Stokhos::FlatSparse3Tensor< ValueType, ExecutionSpace >::m_flops

private

Definition at line 84 of file Stokhos_FlatSparse3Tensor.hpp.

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

Stokhos_FlatSparse3Tensor.hpp