E.V.E  0.1-beta

◆ sech

eve::sech = {}
inlineconstexpr

Callable object computing sech: \(\frac2{e^x-e^{-x}}\).

Required header: #include <eve/function/sech.hpp>

Members Functions

Member Effect
operator() the computation of sech
operator[] Construct a conditional version of current function object

auto operator()(floating_value auto x) const noexcept;
Definition: value.hpp:83

Parameters

x: floating real value.

Return value

Returns the elementwise hyperbolic secant of the input.

In particular:

  • If the element is \(\pm0\), 1 is returned.
  • If the element is \(\pm\infty\), \(+0\) is returned.
  • If the element is a NaN, NaN is returned.

auto operator[]( conditional_expression auto cond ) const noexcept;

Higher-order function generating a masked version of eve::sech

Parameters

cond : conditional expression

Return value

A Callable object so that the expression sech[cond](x, ...) is equivalent to if_else(cond,sech(x, ...),x)


Supported decorators

Example

See it live on Compiler Explorer

#include <eve/function/sech.hpp>
#include <eve/wide.hpp>
#include <eve/constant/inf.hpp>
#include <eve/constant/nan.hpp>
#include <iostream>
int main()
{
wide_ft pf = {1.0f, 0.0f, eve::inf(eve::as<float>()), eve::nan(eve::as<float>())};
std::cout << "---- simd" << '\n'
<< "<- pf = " << pf << '\n'
<< "-> sech(pf) = " << eve::sech(pf) << '\n';
float xf = 3.0f;
std::cout << "---- scalar" << '\n'
<< "<- xf = " << xf << '\n'
<< "-> sech(xf) = " << eve::sech(xf) << '\n';
return 0;
}
constexpr callable_nan_ nan
Callable object computing the nan value.
Definition: nan.hpp:52
constexpr callable_inf_ inf
Callable object computing the infinity ieee value.
Definition: inf.hpp:54
constexpr callable_sech_ sech
Callable object computing sech: .
Definition: sech.hpp:82
Lightweight type-wrapper.
Definition: as.hpp:29
Wrapper for SIMD registers.
Definition: wide.hpp:65