FunctionSquare of the hyperbolic secant function
Syntax C/C++#include <VFmath.h>
int VF_sech2( fVector Y, fVector X, ui size );
int VFx_sech2( fVector Y, fVector X, ui size, float A, float B, float C );
C++ VecObj#include <OptiVec.h>
int vector<T>::sech2( const vector<T>& X );
int vector<T>::x_sech2( const vector<T>& X, const T& A, const T& B, const T& C );
Pascal/Delphiuses VFmath;
function VF_sech2( Y, X:fVector; size:UIntSize ): IntBool;
function VFx_sech2( Y, X:fVector; size:UIntSize; A, B, C:Single ): IntBool;
CUDA function C/C++#include <cudaVFmath.h>
int cudaVF_sech2( fVector d_Y, fVector d_X, ui size );
int cudaVFx_sech2( fVector d_Y, fVector d_X, ui size, float A, float B, float C );
int cusdVFx_sech2( fVector d_Y, fVector d_X, ui size, float *d_A, float *d_B, float *d_C );
int VFcu_sech2( fVector h_Y, fVector h_X, ui size );
int VFxcu_sech2( fVector h_Y, fVector h_X, ui size, float A, float B, float C );
CUDA function Pascal/Delphiuses VFmath;
function cudaVF_sech2( d_Y, d_X:fVector; size:UIntSize ): IntBool;
function cudaVFx_sech2( d_Y, d_X:fVector; size:UIntSize; A, B, C:Single ): IntBool;
function cusdVFx_sech2( d_Y, d_X:fVector; size:UIntSize; d_A, d_B, d_C:PSingle ): IntBool;
function VFcu_sech2( h_Y, h_X:fVector; size:UIntSize ): IntBool;
function VFxcu_sech2( h_Y, h_X:fVector; size:UIntSize; A, B, C:Single ): IntBool;
Descriptionnormal versions: Yi = sech2( Xi )
expanded versions: Yi = C * sech2( A*Xi+B )
The sech2 function is used in physics, e.g., to describe the shape of ultrashort light pulses. Compared to a Gaussian or Lorentzian pulse shape of the same autocorrelation width (see VF_autocorr), the sech2 function has the smallest FWHM (full width to half maximum).
Error handlingThese functions should be error-proof.
Return valuealways FALSE (0)
See alsoVF_sech,   VF_sinh,   VF_exp,   VF_Gauss,   VF_Lorentz

VectorLib Table of Contents  OptiVec home