Class representing a generic buffer. More...

#include <backend.hpp>

Inheritance diagram for backend::buffer< T >:

Public Types
typedef T	base
	Type def to retrieve the backend T type.

Public Member Functions
	buffer ()
	Construct an empty buffer backend.

	buffer (const size_t s)
	Construct a buffer backend with a size.

	buffer (const size_t s, const T d)
	Construct a buffer backend with a size.

	buffer (const std::vector< T > &d)
	Construct a buffer backend from a vector.

	buffer (const buffer &d)
	Construct a buffer backend from a buffer backend.

	buffer (const T min, const T dx, const size_t num)
	Construct a buffer backend linearly.

void	set (const T d)
	Assign a constant value.

void	set (const std::vector< T > &d)
	Assign a vector value.

bool	is_same () const
	Is every element the same.

bool	is_zero () const
	Is every element zero.

bool	has_zero () const
	Is any element zero.

bool	is_negative () const
	Is every element negative.

bool	is_even () const
	Is every element even.

bool	is_none () const
	Is every element negative one.

void	sqrt ()
	Take sqrt.

void	exp ()
	Take exp.

void	log ()
	Take log.

void	sin ()
	Take sin.

void	cos ()
	Take cos.

void	real ()
	Take cos.

void	erf ()
	Take erf.

void	erfi ()
	Take erfi.

bool	is_normal () const
	Check for normal values.

buffer< T >	index_row (const size_t index, const size_t num_columns)
	Index row.

buffer< T >	index_column (const size_t index, const size_t num_columns)
	Index column.

void	add_row (const buffer< T > &x)
	Add row operation.

void	add_col (const buffer< T > &x)
	Add col operation.

void	subtract_row (const buffer< T > &x)
	Subtract row operation.

void	subtract_col (const buffer< T > &x)
	Subtract col operation.

void	multiply_row (const buffer< T > &x)
	Multiply row operation.

void	multiply_col (const buffer< T > &x)
	Multiply col operation.

void	divide_row (const buffer< T > &x)
	Divide row operation.

void	divide_col (const buffer< T > &x)
	Divide col operation.

void	min_row (const buffer< T > &x)
	Min row operation.

void	min_col (const buffer< T > &x)
	Min col operation.

void	atan_row (const buffer< T > &x)
	Atan row operation.

void	atan_col (const buffer< T > &x)
	Atan col operation.

void	pow_row (const buffer< T > &x)
	Pow row operation.

void	pow_col (const buffer< T > &x)
	Pow col operation.

void	hypot_row (const buffer< T > &x)
	Hypot row operation.

void	hypot_col (const buffer< T > &x)
	Hypot col operation.

void	copysign_row (const buffer< T > &x)
	copysign row operation.

void	copysign_col (const buffer< T > &x)
	copysign col operation.

buffer< T >	operator! ()
	Not operation.

buffer< T >	if_ (const buffer< T > &t, const buffer< T > &f)
	Apply condition.

void	isinf ()
	isinf query.

void	isnan ()
	isnan query.

Detailed Description

template<jit::float_scalar T>
class backend::buffer< T >

Class representing a generic buffer.

Template Parameters

T	Base type of the calculation.

Constructor & Destructor Documentation

◆ buffer() [1/5]

template<jit::float_scalar T>

backend::buffer< T >::buffer ( const size_t s )

inline

Construct a buffer backend with a size.

Parameters

[in] s Size of he data buffer.

◆ buffer() [2/5]

template<jit::float_scalar T>

backend::buffer< T >::buffer	(	const size_t	s,
		const T	d
	)

inline

Construct a buffer backend with a size.

Parameters

[in]	s	Size of he data buffer.
[in]	d	Scalar data to initialize.

◆ buffer() [3/5]

template<jit::float_scalar T>

backend::buffer< T >::buffer ( const std::vector< T > & d )

inline

Construct a buffer backend from a vector.

Parameters

[in] d Array buffer.

◆ buffer() [4/5]

template<jit::float_scalar T>

backend::buffer< T >::buffer ( const buffer< T > & d )

inline

Construct a buffer backend from a buffer backend.

Parameters

[in] d Backend buffer.

◆ buffer() [5/5]

template<jit::float_scalar T>

backend::buffer< T >::buffer	(	const T	min,
		const T	dx,
		const size_t	num
	)

inline

Construct a buffer backend linearly.

Parameters

[in]	min	Minimum value..
[in]	dx	Step size.
[in]	num	Number of mesh points.

Member Function Documentation

◆ add_col()

template<jit::float_scalar T>

void backend::buffer< T >::add_col ( const buffer< T > & x )

inline

Add col operation.

Adds m_ij + v_j or v_j + m_ij. This will resize the buffer if it needs to be.

Parameters

[in] x The other operand.

◆ add_row()

template<jit::float_scalar T>

void backend::buffer< T >::add_row ( const buffer< T > & x )

inline

Add row operation.

Adds m_ij + v_i or v_i + m_ij. This will resize the buffer if it needs to be.

Parameters

[in] x The right operand.

◆ atan_col()

template<jit::float_scalar T>

void backend::buffer< T >::atan_col ( const buffer< T > & x )

inline

Atan col operation.

Computes atan(m_ij, v_j) or atan(v_j, m_ij). This will resize the buffer if it needs to be.

Parameters

[in] x The other operand.

◆ atan_row()

template<jit::float_scalar T>

void backend::buffer< T >::atan_row ( const buffer< T > & x )

inline

Atan row operation.

Computes atan(m_ij, v_i) or atan(v_i, m_ij). This will resize the buffer if it needs to be.

Parameters

[in] x The right operand.

◆ copysign_col()

template<jit::float_scalar T>

void backend::buffer< T >::copysign_col ( const buffer< T > & x )

inline

copysign col operation.

Computes atan(m_ij, v_j) or atan(v_j, m_ij). This will resize the buffer if it needs to be.

Parameters

[in] x The other operand.

◆ copysign_row()

template<jit::float_scalar T>

void backend::buffer< T >::copysign_row ( const buffer< T > & x )

inline

copysign row operation.

Computes copysign(m_ij, v_i) or copysign(v_i, m_ij). This will resize the buffer if it needs to be.

Parameters

[in] x The right operand.

◆ divide_col()

template<jit::float_scalar T>

void backend::buffer< T >::divide_col ( const buffer< T > & x )

inline

Divide col operation.

Divides m_ij / v_j or v_j / m_ij. This will resize the buffer if it needs to be.

Parameters

[in] x The other operand.

◆ divide_row()

template<jit::float_scalar T>

void backend::buffer< T >::divide_row ( const buffer< T > & x )

inline

Divide row operation.

Divides m_ij / v_i or v_i / m_ij. This will resize the buffer if it needs to be.

Parameters

[in] x The right operand.

◆ has_zero()

template<jit::float_scalar T>

bool backend::buffer< T >::has_zero ( ) const

inline

Is any element zero.

Returns: Returns true if any element is zero.

◆ hypot_col()

template<jit::float_scalar T>

void backend::buffer< T >::hypot_col ( const buffer< T > & x )

inline

Hypot col operation.

Computes Hypot(m_ij, v_j) or Hypot(v_j, m_ij). This will resize the buffer if it needs to be.

Parameters

[in] x The other operand.

◆ hypot_row()

template<jit::float_scalar T>

void backend::buffer< T >::hypot_row ( const buffer< T > & x )

inline

Hypot row operation.

Computes Hypot(m_ij, v_i) or Hypot(v_i, m_ij). This will resize the buffer if it needs to be.

Parameters

[in] x The right operand.

◆ if_()

template<jit::float_scalar T>

buffer< T > backend::buffer< T >::if_	(	const buffer< T > &	t,
		const buffer< T > &	f
	)

inline

Apply condition.

@params[in] t True condition. @params[in] f False condition.

◆ index_column()

template<jit::float_scalar T>

buffer< T > backend::buffer< T >::index_column	(	const size_t	index,
		const size_t	num_columns
	)

inline

Index column.

Parameters

[in]	index	The row index.
[in]	num_columns	The number of coils.

Returns: A buffer containing the row.

◆ index_row()

template<jit::float_scalar T>

buffer< T > backend::buffer< T >::index_row	(	const size_t	index,
		const size_t	num_columns
	)

inline

Index row.

Parameters

[in]	index	The row index.
[in]	num_columns	The number of coils.

Returns: A buffer containing the row.

◆ is_even()

template<jit::float_scalar T>

bool backend::buffer< T >::is_even ( ) const

inline

Is every element even.

Returns: Returns true if every element is negative.

◆ is_negative()

template<jit::float_scalar T>

bool backend::buffer< T >::is_negative ( ) const

inline

Is every element negative.

Returns: Returns true if every element is negative.

◆ is_none()

template<jit::float_scalar T>

bool backend::buffer< T >::is_none ( ) const

inline

Is every element negative one.

Returns: Returns true if every element is negative one.

◆ is_normal()

template<jit::float_scalar T>

bool backend::buffer< T >::is_normal ( ) const

inline

Check for normal values.

Returns: False if any NaN or Inf is found.

◆ is_same()

template<jit::float_scalar T>

bool backend::buffer< T >::is_same ( ) const

inline

Is every element the same.

Returns: Returns true if every element is the same.

◆ is_zero()

template<jit::float_scalar T>

bool backend::buffer< T >::is_zero ( ) const

inline

Is every element zero.

Returns: Returns true if every element is zero.

◆ min_col()

template<jit::float_scalar T>

void backend::buffer< T >::min_col ( const buffer< T > & x )

inline

Min col operation.

Takes Min(m_ij, v_j) or Min(v_j, m_ij). This will resize the buffer if it needs to be.

Parameters

[in] x The other operand.

◆ min_row()

template<jit::float_scalar T>

void backend::buffer< T >::min_row ( const buffer< T > & x )

inline

Min row operation.

Takes Min(m_ij, v_i) or Min(v_i, m_ij). This will resize the buffer if it needs to be.

Parameters

[in] x The other operand.

◆ multiply_col()

template<jit::float_scalar T>

void backend::buffer< T >::multiply_col ( const buffer< T > & x )

inline

Multiply col operation.

Multiplies m_ij * v_j or v_j * m_ij. This will resize the buffer if it needs to be.

Parameters

[in] x The other operand.

◆ multiply_row()

template<jit::float_scalar T>

void backend::buffer< T >::multiply_row ( const buffer< T > & x )

inline

Multiply row operation.

Multiplies m_ij * v_i or v_i * m_ij. This will resize the buffer if it needs to be.

Parameters

[in] x The right operand.

◆ operator!()

template<jit::float_scalar T>

buffer< T > backend::buffer< T >::operator! ( )

inline

Not operation.

Returns: The negation of the buffer.

◆ pow_col()

template<jit::float_scalar T>

void backend::buffer< T >::pow_col ( const buffer< T > & x )

inline

Pow col operation.

Computes pow(m_ij, v_j) or pow(v_j, m_ij). This will resize the buffer if it needs to be.

Parameters

[in] x The other operand.

◆ pow_row()

template<jit::float_scalar T>

void backend::buffer< T >::pow_row ( const buffer< T > & x )

inline

Pow row operation.

Computes pow(m_ij, v_i) or pow(v_i, m_ij). This will resize the buffer if it needs to be.

Parameters

[in] x The right operand.

◆ set() [1/2]

template<jit::float_scalar T>

void backend::buffer< T >::set ( const std::vector< T > & d )

inline

Assign a vector value.

Parameters

[in] d Vector data to set.

◆ set() [2/2]

template<jit::float_scalar T>

void backend::buffer< T >::set ( const T d )

inline

Assign a constant value.

Parameters

[in] d Scalar data to set.

◆ subtract_col()

template<jit::float_scalar T>

void backend::buffer< T >::subtract_col ( const buffer< T > & x )

inline

Subtract col operation.

Subtracts m_ij - v_j or v_j - m_ij. This will resize the buffer if it needs to be.

Parameters

[in] x The other operand.

◆ subtract_row()

template<jit::float_scalar T>

void backend::buffer< T >::subtract_row ( const buffer< T > & x )

inline

Subtract row operation.

Subtracts m_ij - v_i or v_i - m_ij. This will resize the buffer if it needs to be.

Parameters

[in] x The right operand.

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

graph_framework/backend.hpp

Public Types

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ buffer() [1/5]

◆ buffer() [2/5]

◆ buffer() [3/5]

◆ buffer() [4/5]

◆ buffer() [5/5]

Member Function Documentation

◆ add_col()

◆ add_row()

◆ atan_col()

◆ atan_row()

◆ copysign_col()

◆ copysign_row()

◆ divide_col()

◆ divide_row()

◆ has_zero()

◆ hypot_col()

◆ hypot_row()

◆ if_()

◆ index_column()

◆ index_row()

◆ is_even()

◆ is_negative()

◆ is_none()

◆ is_normal()

◆ is_same()

◆ is_zero()

◆ min_col()

◆ min_row()

◆ multiply_col()

◆ multiply_row()

◆ operator!()

◆ pow_col()

◆ pow_row()

◆ set() [1/2]

◆ set() [2/2]

◆ subtract_col()

◆ subtract_row()