94 lines
2.1 KiB
Markdown
94 lines
2.1 KiB
Markdown
|
<!--
|
||
|
|
|
||
|
|
@license Apache-2.0
|
||
|
|
|
||
|
|
Copyright (c) 2018 The Stdlib Authors.
|
||
|
|
|
||
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||
|
|
you may not use this file except in compliance with the License.
|
||
|
|
You may obtain a copy of the License at
|
||
|
|
|
||
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
||
|
|
|
||
|
|
Unless required by applicable law or agreed to in writing, software
|
||
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
|
|
See the License for the specific language governing permissions and
|
||
|
|
limitations under the License.
|
||
|
|
|
||
|
|
-->
|
||
|
|
|
||
|
|
# Cube Root of Epsilon
|
||
|
|
|
||
|
|
> [Cube root][@stdlib/math/base/special/cbrt] of [half-precision floating-point epsilon][@stdlib/constants/float16/eps].
|
||
|
|
|
||
|
|
<section class="usage">
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var FLOAT16_CBRT_EPSILON = require( '@stdlib/constants/float16/cbrt-eps' );
|
||
|
|
```
|
||
|
|
|
||
|
|
#### FLOAT16_CBRT_EPSILON
|
||
|
|
|
||
|
|
[Cube root][@stdlib/math/base/special/cbrt] of [half-precision floating-point epsilon][@stdlib/constants/float16/eps].
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var bool = ( FLOAT16_CBRT_EPSILON === 0.09921256574801247 );
|
||
|
|
// returns true
|
||
|
|
```
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.usage -->
|
||
|
|
|
||
|
|
<section class="examples">
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
<!-- eslint no-undef: "error" -->
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var abs = require( '@stdlib/math/base/special/abs' );
|
||
|
|
var maxabs = require( '@stdlib/math/base/special/maxabs' );
|
||
|
|
var randu = require( '@stdlib/random/base/randu' );
|
||
|
|
var FLOAT16_CBRT_EPSILON = require( '@stdlib/constants/float16/cbrt-eps' );
|
||
|
|
|
||
|
|
var bool;
|
||
|
|
var a;
|
||
|
|
var b;
|
||
|
|
var i;
|
||
|
|
|
||
|
|
function isApprox( a, b ) {
|
||
|
|
var delta;
|
||
|
|
var tol;
|
||
|
|
|
||
|
|
delta = abs( a - b );
|
||
|
|
tol = FLOAT16_CBRT_EPSILON * maxabs( a, b );
|
||
|
|
|
||
|
|
return ( delta <= tol );
|
||
|
|
}
|
||
|
|
|
||
|
|
for ( i = 0; i < 100; i++ ) {
|
||
|
|
a = randu() * 10.0;
|
||
|
|
b = a + randu() - 0.5;
|
||
|
|
bool = isApprox( a, b );
|
||
|
|
console.log( '%d %s approximately equal to %d', a, ( bool ) ? 'is' : 'is not', b );
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.examples -->
|
||
|
|
|
||
|
|
<section class="links">
|
||
|
|
|
||
|
|
[@stdlib/math/base/special/cbrt]: https://www.npmjs.com/package/@stdlib/math-base-special-cbrt
|
||
|
|
|
||
|
|
[@stdlib/constants/float16/eps]: https://www.npmjs.com/package/@stdlib/constants/tree/main/float16/eps
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.links -->
|