C++ API Reference for Intel® Data Analytics Acceleration Library 2018 Update 2

List of all members
Batch< algorithmFPType, method > Class Template Reference

Computes the hyperbolic tangent function in the batch processing mode. More...

Class Declaration

template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
class daal::algorithms::math::tanh::interface1::Batch< algorithmFPType, method >

Template Parameters
algorithmFPTypeData type to use in intermediate computations for the hyperbolic tangent function, double or float
methodThe hyperbolic tangent function computation method
Enumerations
  • Method Computation methods for the hyperbolic tangent function
  • InputId Identifiers of input objects for the hyperbolic tangent function
  • ResultId Result identifiers for the the hyperbolic tangent function

Constructor & Destructor Documentation

◆ Batch() [1/2]

Batch ( )
inline

Default constructor

◆ Batch() [2/2]

Batch ( const Batch< algorithmFPType, method > &  other)
inline

Constructs the hyperbolic tangent function by copying input objects of another hyperbolic tangent function

Parameters
[in]otherfunction to be used as the source to initialize the input objects of the hyperbolic tangent function

Member Function Documentation

◆ clone()

services::SharedPtr<Batch<algorithmFPType, method> > clone ( ) const
inline

Returns a pointer to a newly allocated hyperbolic tangent function with a copy of the input objects of this hyperbolic tangent function

Returns
Pointer to the newly allocated hyperbolic tangent function

◆ getMethod()

virtual int getMethod ( ) const
inlinevirtual

Returns the method of the hyperbolic tangent function

Returns
Method of the hyperbolic tangent function

Implements AlgorithmIface.

◆ getResult()

ResultPtr getResult ( )
inline

Returns the structure that contains the result of the hyperbolic tangent function

Returns
Structure that contains the result of the hyperbolic tangent function

◆ setResult()

services::Status setResult ( const ResultPtr result)
inline

Registers user-allocated memory to store the result of the hyperbolic tangent function

Parameters
[in]resultStructure to store the result of the hyperbolic tangent function
Returns
Status of computation

Member Data Documentation

◆ input

InputType input

Input data structure


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

For more complete information about compiler optimizations, see our Optimization Notice.