tensorium::DerivateND< K, Rank > Class Template Reference

A multi-dimensional aligned tensor for numerical derivatives. More...

#include <Derivate.hpp>

Collaboration diagram for tensorium::DerivateND< K, Rank >:

Public Types
using	reg = typename Simd::reg
using	reg = typename Simd::reg

Public Member Functions
	DerivateND (const std::array< size_t, Rank > &dims)
	Construct a tensor with a given shape.
size_t	flatten_index (const std::array< size_t, Rank > &indices) const
K &	operator() (const std::array< size_t, Rank > &indices)
	Mutable access to a tensor element.
const K &	operator() (const std::array< size_t, Rank > &indices) const
	Const access to a tensor element.
size_t	size () const
	Total number of elements in the tensor.
	__attribute__ ((always_inline, hot, flatten)) inline void centered_derivative(const DerivateND< K
	Compute second-order centered derivative along an axis.
	for (int i=Rank - 2;i >=0;--i) strides[i]
	for (size_t flat=0;flat< total;flat+=simd_width)
	__attribute__ ((always_inline, hot, flatten)) inline void centered_derivative_order4_rank(const DerivateND< K
	Compute fourth-order centered derivative along an axis.
	for (int i=Rank - 2;i >=0;--i) strides[i]
	for (size_t flat=0;flat< total;flat+=W)

Public Attributes
std::array< size_t, Rank >	shape = input.shape
aligned_vector< K >	data
size_t	block_size
Rank &	input
Rank DerivateND< K, Rank > &	output
Rank DerivateND< K, Rank > size_t	axis
Rank DerivateND< K, Rank > size_t K dx	const
const size_t	simd_width = Simd::width
const auto &	shape = input.shape
const size_t	total = input.size()
const K	inv_2dx = K(1) / (K(2) * dx)
const reg	inv2dx = Simd::set1(inv_2dx)
std::array< size_t, Rank >	strides
	strides [Rank - 1] = 1
const size_t	stride_axis = strides[axis]
const size_t	dim_axis = shape[axis]
constexpr size_t	W = Simd::width
const K	inv_12dx = K(1) / (K(12) * dx)
const reg	inv = Simd::set1(inv_12dx)

Detailed Description

template<typename K, size_t Rank>
class tensorium::DerivateND< K, Rank >

A multi-dimensional aligned tensor for numerical derivatives.

Template Parameters

K	Scalar type.
Rank	Tensor rank (dimensionality).

Member Typedef Documentation

reg [1/2]

template<typename K , size_t Rank>

using tensorium::DerivateND< K, Rank >::reg = typename Simd::reg

reg [2/2]

template<typename K , size_t Rank>

using tensorium::DerivateND< K, Rank >::reg = typename Simd::reg

Constructor & Destructor Documentation

DerivateND()

template<typename K , size_t Rank>

tensorium::DerivateND< K, Rank >::DerivateND ( const std::array< size_t, Rank > & dims )

inline

Construct a tensor with a given shape.

Parameters

dims	Tensor dimensions.

References tensorium::DerivateND< K, Rank >::block_size.

Member Function Documentation

__attribute__() [1/2]

template<typename K , size_t Rank>

tensorium::DerivateND< K, Rank >::__attribute__

(

(always_inline, hot, flatten)

)

const

Compute second-order centered derivative along an axis.

Parameters

input	Input tensor.
output	Output tensor.
axis	Axis to differentiate.
dx	Grid spacing.

__attribute__() [2/2]

template<typename K , size_t Rank>

tensorium::DerivateND< K, Rank >::__attribute__

(

(always_inline, hot, flatten)

)

const

Compute fourth-order centered derivative along an axis.

Parameters

input	Input tensor.
output	Output tensor.
axis	Axis to differentiate.
dx	Grid spacing.

flatten_index()

template<typename K , size_t Rank>

size_t tensorium::DerivateND< K, Rank >::flatten_index ( const std::array< size_t, Rank > & indices ) const

inline

References tensorium::DerivateND< K, Rank >::shape.

Referenced by tensorium::DerivateND< K, Rank >::operator()(), and tensorium::DerivateND< K, Rank >::operator()().

Here is the caller graph for this function:

for() [1/4]

template<typename K , size_t Rank>

tensorium::DerivateND< K, Rank >::for

(

int

i = Rank - 2;i >=0;--i

)

for() [2/4]

template<typename K , size_t Rank>

tensorium::DerivateND< K, Rank >::for

(

int

i = Rank - 2;i >=0;--i

)

for() [3/4]

template<typename K , size_t Rank>

tensorium::DerivateND< K, Rank >::for ( )

inline

References tensorium::DerivateND< K, Rank >::dim_axis, tensorium::DerivateND< K, Rank >::input, tensorium::DerivateND< K, Rank >::inv2dx, tensorium::DerivateND< K, Rank >::inv_2dx, tensorium::DerivateND< K, Rank >::output, tensorium::DerivateND< K, Rank >::simd_width, tensorium::DerivateND< K, Rank >::stride_axis, and tensorium::DerivateND< K, Rank >::total.

for() [4/4]

template<typename K , size_t Rank>

tensorium::DerivateND< K, Rank >::for ( )

inline

References tensorium::DerivateND< K, Rank >::dim_axis, tensorium::DerivateND< K, Rank >::input, tensorium::DerivateND< K, Rank >::inv, tensorium::DerivateND< K, Rank >::inv_12dx, tensorium::DerivateND< K, Rank >::output, tensorium::DerivateND< K, Rank >::stride_axis, tensorium::DerivateND< K, Rank >::total, and tensorium::DerivateND< K, Rank >::W.

operator()() [1/2]

template<typename K , size_t Rank>

K & tensorium::DerivateND< K, Rank >::operator() ( const std::array< size_t, Rank > & indices )

inline

Mutable access to a tensor element.

Parameters

indices

Multi-index.

Returns

Reference to the element.

References tensorium::DerivateND< K, Rank >::data, and tensorium::DerivateND< K, Rank >::flatten_index().

Here is the call graph for this function:

operator()() [2/2]

template<typename K , size_t Rank>

const K & tensorium::DerivateND< K, Rank >::operator() ( const std::array< size_t, Rank > & indices ) const

inline

Const access to a tensor element.

Parameters

indices

Multi-index.

Returns

Const reference to the element.

References tensorium::DerivateND< K, Rank >::data, and tensorium::DerivateND< K, Rank >::flatten_index().

Here is the call graph for this function:

size()

template<typename K , size_t Rank>

size_t tensorium::DerivateND< K, Rank >::size ( ) const

inline

Total number of elements in the tensor.

Returns

Total size.

References tensorium::DerivateND< K, Rank >::data.

Member Data Documentation

axis

template<typename K , size_t Rank>

Rank DerivateND< K, Rank > size_t tensorium::DerivateND< K, Rank >::axis

block_size

template<typename K , size_t Rank>

size_t tensorium::DerivateND< K, Rank >::block_size

Referenced by tensorium::DerivateND< K, Rank >::DerivateND().

const

template<typename K , size_t Rank>

Rank DerivateND< K, Rank > size_t K dx tensorium::DerivateND< K, Rank >::const

Initial value:

{
        using Simd = simd::SimdTraits<K, DefaultISA>

data

template<typename K , size_t Rank>

aligned_vector<K> tensorium::DerivateND< K, Rank >::data

Referenced by tensorium::DerivateND< K, Rank >::operator()(), tensorium::DerivateND< K, Rank >::operator()(), and tensorium::DerivateND< K, Rank >::size().

dim_axis

template<typename K , size_t Rank>

const size_t tensorium::DerivateND< K, Rank >::dim_axis = shape[axis]

Referenced by tensorium::DerivateND< K, Rank >::for(), and tensorium::DerivateND< K, Rank >::for().

input

template<typename K , size_t Rank>

Rank & tensorium::DerivateND< K, Rank >::input

Referenced by tensorium::DerivateND< K, Rank >::for(), and tensorium::DerivateND< K, Rank >::for().

inv

template<typename K , size_t Rank>

const reg tensorium::DerivateND< K, Rank >::inv = Simd::set1(inv_12dx)

Referenced by tensorium::DerivateND< K, Rank >::for().

inv2dx

template<typename K , size_t Rank>

const reg tensorium::DerivateND< K, Rank >::inv2dx = Simd::set1(inv_2dx)

Referenced by tensorium::DerivateND< K, Rank >::for().

inv_12dx

template<typename K , size_t Rank>

const K tensorium::DerivateND< K, Rank >::inv_12dx = K(1) / (K(12) * dx)

Referenced by tensorium::DerivateND< K, Rank >::for().

inv_2dx

template<typename K , size_t Rank>

const K tensorium::DerivateND< K, Rank >::inv_2dx = K(1) / (K(2) * dx)

Referenced by tensorium::DerivateND< K, Rank >::for().

output

template<typename K , size_t Rank>

Rank DerivateND< K, Rank > & tensorium::DerivateND< K, Rank >::output

Referenced by tensorium::DerivateND< K, Rank >::for(), and tensorium::DerivateND< K, Rank >::for().

shape [1/2]

template<typename K , size_t Rank>

const auto & tensorium::DerivateND< K, Rank >::shape = input.shape

Referenced by tensorium::DerivateND< K, Rank >::flatten_index().

shape [2/2]

template<typename K , size_t Rank>

const auto& tensorium::DerivateND< K, Rank >::shape = input.shape

simd_width

template<typename K , size_t Rank>

const size_t tensorium::DerivateND< K, Rank >::simd_width = Simd::width

Referenced by tensorium::DerivateND< K, Rank >::for().

stride_axis

template<typename K , size_t Rank>

const size_t tensorium::DerivateND< K, Rank >::stride_axis = strides[axis]

Referenced by tensorium::DerivateND< K, Rank >::for(), and tensorium::DerivateND< K, Rank >::for().

strides [1/2]

template<typename K , size_t Rank>

std::array< size_t, Rank > tensorium::DerivateND< K, Rank >::strides

strides [2/2]

template<typename K , size_t Rank>

tensorium::DerivateND< K, Rank >::strides[Rank - 1] = 1

total

template<typename K , size_t Rank>

const size_t tensorium::DerivateND< K, Rank >::total = input.size()

Referenced by tensorium::DerivateND< K, Rank >::for(), and tensorium::DerivateND< K, Rank >::for().

W

template<typename K , size_t Rank>

constexpr size_t tensorium::DerivateND< K, Rank >::W = Simd::width

constexpr

Referenced by tensorium::DerivateND< K, Rank >::for().

---

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

• includes/Tensorium/Core/Derivate.hpp