Public Member Functions | Static Public Member Functions | List of all members
blaze::Hypot Struct Reference

Generic wrapper for the hypot() function. More...

#include <Hypot.h>

Public Member Functions

 Hypot ()
 Default constructor of the Hypot functor.
 
template<typename T1 , typename T2 >
decltype(auto) BLAZE_ALWAYS_INLINE operator() (const T1 &a, const T2 &b) const
 Returns the result of the hypot() function for the given objects/values. More...
 
template<typename T1 , typename T2 >
decltype(auto) BLAZE_ALWAYS_INLINE load (const T1 &a, const T2 &b) const
 Returns the result of the hypot() function for the given SIMD vectors. More...
 

Static Public Member Functions

template<typename T1 , typename T2 >
static constexpr bool simdEnabled ()
 Returns whether SIMD is enabled for the specified data types T1 and T2. More...
 
static constexpr bool paddingEnabled ()
 Returns whether the operation supports padding, i.e. whether it can deal with zeros. More...
 

Detailed Description

Generic wrapper for the hypot() function.

Member Function Documentation

◆ load()

template<typename T1 , typename T2 >
decltype(auto) BLAZE_ALWAYS_INLINE blaze::Hypot::load ( const T1 &  a,
const T2 &  b 
) const
inline

Returns the result of the hypot() function for the given SIMD vectors.

Parameters
aThe left-hand side SIMD vector.
bThe right-hand side SIMD vector.
Returns
The result of the hypot() function for the given SIMD vectors.

◆ operator()()

template<typename T1 , typename T2 >
decltype(auto) BLAZE_ALWAYS_INLINE blaze::Hypot::operator() ( const T1 &  a,
const T2 &  b 
) const
inline

Returns the result of the hypot() function for the given objects/values.

Parameters
aThe left-hand side object/value.
bThe right-hand side object/value.
Returns
The result of the hypot() function for the given objects/values.

◆ paddingEnabled()

static constexpr bool blaze::Hypot::paddingEnabled ( )
inlinestatic

Returns whether the operation supports padding, i.e. whether it can deal with zeros.

Returns
true in case padding is supported, false if not.

◆ simdEnabled()

template<typename T1 , typename T2 >
static constexpr bool blaze::Hypot::simdEnabled ( )
inlinestatic

Returns whether SIMD is enabled for the specified data types T1 and T2.

Returns
true in case SIMD is enabled for the data types T1 and T2, false if not.

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