SecreC 2 language  2.8.0 (2023.09)
Language and standard library reference
Functions
isNegligible

Functions

template<domain D :shared3p >
D bool isNegligible (D float32 a)
 
template<domain D :shared3p >
D bool isNegligible (D float64 a)
 
template<domain D :shared3p >
D bool isNegligible (D float32[[1]] a)
 
template<domain D :shared3p >
D bool isNegligible (D float64[[1]] a)
 

Detailed Description

Function for finding if the error is small enough to neglect.

Note
D - shared3p protection domain
Supported types - float32 / float64
Returns
returns true if the error is small enough to neglect
returns false if the error is not small enough
Note
isNegligible checks up to the 5th place after the comma
this does not quite match public isNegligible
Leakage
None

Function Documentation

◆ isNegligible() [1/4]

D bool isNegligible ( D float32  a)
Parameters
a- a scalar of supported type
Returns
returns true if the error is small enough to neglect
returns false if the error is not small enough

◆ isNegligible() [2/4]

D bool isNegligible ( D float32[[1]]  a)
Parameters
a- a vector of supported type
Returns
returns a vector where each element of the input vector has been evaluated, whether the error is small enough to neglect or not

◆ isNegligible() [3/4]

D bool isNegligible ( D float64  a)
Parameters
a- a scalar of supported type
Returns
returns true if the error is small enough to neglect
returns false if the error is not small enough

◆ isNegligible() [4/4]

D bool isNegligible ( D float64[[1]]  a)
Parameters
a- a vector of supported type
Returns
returns a vector where each element of the input vector has been evaluated, whether the error is small enough to neglect or not