Functions

AFAPI array product (const array &in, const int dim=-1)
 C++ Interface for product of elements in an array. More...
 
AFAPI array product (const array &in, const int dim, const double nanval)
 C++ Interface for product of elements in an array while replacing nan values. More...
 
template<typename T >
product (const array &in)
 C++ Interface for product of all elements in an array. More...
 
template<typename T >
product (const array &in, double nanval)
 C++ Interface for product of all elements in an array while replacing nan values. More...
 
AFAPI af_err af_product (af_array *out, const af_array in, const int dim)
 C Interface for product of elements in an array. More...
 
AFAPI af_err af_product_nan (af_array *out, const af_array in, const int dim, const double nanval)
 C Interface for product of elements in an array while replacing nans. More...
 
AFAPI af_err af_product_all (double *real, double *imag, const af_array in)
 C Interface for product of all elements in an array. More...
 
AFAPI af_err af_product_nan_all (double *real, double *imag, const af_array in, const double nanval)
 C Interface for product of all elements in an array while replacing nans. More...
 
AFAPI array mul (const array &in, const int dim=-1)
 C++ Interface for product of elements in an array. More...
 
template<typename T >
mul (const array &in)
 C++ Interface for product of all elements in an array. More...
 

Detailed Description

Find the product of values in the input

This table defines the return value types for the corresponding input types

Input Type Output Type
f32, f64, c32, c64 same as input
s32, u32, s64, u64 same as input
s16 s32
u16, u8, b8 u32

This function performs the operation across all batches present in the input simultaneously.

Function Documentation

◆ af_product()

AFAPI af_err af_product ( af_array out,
const af_array  in,
const int  dim 
)

C Interface for product of elements in an array.

Parameters
[out]outwill contain the product of all values in in along dim
[in]inis the input array
[in]dimThe dimension along which the multiply operation occurs
Returns
AF_SUCCESS if the execution completes properly

◆ af_product_all()

AFAPI af_err af_product_all ( double *  real,
double *  imag,
const af_array  in 
)

C Interface for product of all elements in an array.

Parameters
[out]realwill contain the real part of multiplying all elements in input in
[out]imagwill contain the imaginary part of multiplying all elements in input in
[in]inis the input array
Returns
AF_SUCCESS if the execution completes properly
Note
imag is always set to 0 when in is real

◆ af_product_nan()

AFAPI af_err af_product_nan ( af_array out,
const af_array  in,
const int  dim,
const double  nanval 
)

C Interface for product of elements in an array while replacing nans.

Parameters
[out]outwill contain the product of all values in in along dim
[in]inis the input array
[in]dimThe dimension along which the product operation occurs
[in]nanvalThe value that will replace the NaNs in in
Returns
AF_SUCCESS if the execution completes properly

◆ af_product_nan_all()

AFAPI af_err af_product_nan_all ( double *  real,
double *  imag,
const af_array  in,
const double  nanval 
)

C Interface for product of all elements in an array while replacing nans.

Parameters
[out]realwill contain the real part of multiplication of all elements in input in
[out]imagwill contain the imaginary part of multiplication of all elements in input in
[in]inis the input array
[in]nanvalis the value which replaces nan
Returns
AF_SUCCESS if the execution completes properly
Note
imag is always set to 0 when in is real

◆ mul() [1/2]

T af::mul ( const array in)

C++ Interface for product of all elements in an array.

Parameters
[in]inis the input array
Returns
the product of all values of in
Deprecated:
Use product instead

◆ mul() [2/2]

AFAPI array af::mul ( const array in,
const int  dim = -1 
)

C++ Interface for product of elements in an array.

Parameters
[in]inThe input array
[in]dimThe dimension along which the multiply operation occurs
Returns
result of product all values along dimension dim
Note
dim is -1 by default. -1 denotes the first non-singleton dimension.
Deprecated:
Use product instead

◆ product() [1/4]

T af::product ( const array in)

C++ Interface for product of all elements in an array.

Parameters
[in]inis the input array
Returns
the product of all values of in

◆ product() [2/4]

AFAPI array af::product ( const array in,
const int  dim,
const double  nanval 
)

C++ Interface for product of elements in an array while replacing nan values.

Parameters
[in]inThe input array
[in]dimThe dimension along which the multiply operation occurs
[in]nanvalThe value that will replace the NaNs in in
Returns
result of product all values along dimension dim

◆ product() [3/4]

AFAPI array af::product ( const array in,
const int  dim = -1 
)

C++ Interface for product of elements in an array.

Parameters
[in]inThe input array
[in]dimThe dimension along which the multiply operation occurs
Returns
result of product all values along dimension dim
Note
dim is -1 by default. -1 denotes the first non-singleton dimension.
Examples
financial/monte_carlo_options.cpp, and getting_started/integer.cpp.

◆ product() [4/4]

T af::product ( const array in,
double  nanval 
)

C++ Interface for product of all elements in an array while replacing nan values.

Parameters
[in]inis the input array
[in]nanvalThe value that will replace the NaNs in in
Returns
the product of all values of in