yask::yk_var::yk_reduction_result Class Reference

Class returned from reduce_elements_in_slice(). More...

#include <yk_var_api.hpp>

Public Member Functions
virtual int	get_reduction_mask () const =0
	Get the allowed reductions.
virtual idx_t	get_num_elements_reduced () const =0
	Get the number of elements reduced.
virtual double	get_sum () const =0
	Get sum.
virtual double	get_sum_squares () const =0
	Get sum of squares.
virtual double	get_product () const =0
	Get product.
virtual double	get_max () const =0
	Get max.
virtual double	get_min () const =0
	Get min.

Detailed Description

Class returned from reduce_elements_in_slice().

Note

The reduced values are all doubles regardless of the precision of the solution.

Member Function Documentation

get_reduction_mask()

virtual int yask::yk_var::yk_reduction_result::get_reduction_mask ( ) const

pure virtual

Get the allowed reductions.

Returns

the bitmask of reductions provided.

get_num_elements_reduced()

virtual idx_t yask::yk_var::yk_reduction_result::get_num_elements_reduced ( ) const

pure virtual

Get the number of elements reduced.

Returns

the number of elements evaluated.

get_sum()

virtual double yask::yk_var::yk_reduction_result::get_sum ( ) const

pure virtual

Get sum.

Returns

sum of values of elements in slice or zero (0.0) if no elements were evaluated.

Exceptions

yask_exception

if sum was not requested.

get_sum_squares()

virtual double yask::yk_var::yk_reduction_result::get_sum_squares ( ) const

pure virtual

Get sum of squares.

Returns

sum of squares of values of elements in slice or zero (0.0) if no elements were evaluated.

Exceptions

yask_exception

if sum-of-squares was not requested.

get_product()

virtual double yask::yk_var::yk_reduction_result::get_product ( ) const

pure virtual

Get product.

Returns

product of values of elements in slice or one (1.0) if no elements were evaluated.

Exceptions

yask_exception

if product was not requested.

get_max()

virtual double yask::yk_var::yk_reduction_result::get_max ( ) const

pure virtual

Get max.

Returns

maximum of values of elements in slice or MIN_DBL if no elements were evaluated.

Exceptions

yask_exception

if max was not requested.

get_min()

virtual double yask::yk_var::yk_reduction_result::get_min ( ) const

pure virtual

Get min.

Returns

minimum of values of elements in slice or MAX_DBL if no elements were evaluated.

Exceptions

yask_exception

if sum was not requested.

---

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

• yk_var_api.hpp