Data

Tools

Indexes

Applications

Experiments

Open Source Science

complex-float64-base-assert-is-almost-equal

Test whether two double-precision complex floating-point numbers are approximately equal within a specified number of ULPs (units in the last place).

https://github.com/stdlib-js/complex-float64-base-assert-is-almost-equal

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.6%) to scientific vocabulary

Keywords

assert base cmplx compare comparison complex eq equal equality javascript math mathematics node node-js nodejs number same stdlib test validate
Last synced: 6 months ago · JSON representation ·

Repository

Test whether two double-precision complex floating-point numbers are approximately equal within a specified number of ULPs (units in the last place).

Basic Info
Statistics
  • Stars: 0
  • Watchers: 0
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
assert base cmplx compare comparison complex eq equal equality javascript math mathematics node node-js nodejs number same stdlib test validate
Created 7 months ago · Last pushed 7 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Security

README.md

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

isAlmostEqual

NPM version Build Status Coverage Status <!-- dependencies -->

Test whether two double-precision complex floating-point numbers are approximately equal within a specified number of ULPs (units in the last place).

## Installation ```bash npm install @stdlib/complex-float64-base-assert-is-almost-equal ``` Alternatively, - To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]). - If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions). - For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]). The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships. To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
## Usage ```javascript var isAlmostEqual = require( '@stdlib/complex-float64-base-assert-is-almost-equal' ); ``` #### isAlmostEqual( z1, z2, maxULP ) Tests whether two double-precision complex floating-point numbers are approximately equal within a specified number of ULPs (units in the last place). ```javascript var EPS = require( '@stdlib/constants-float64-eps' ); var Complex128 = require( '@stdlib/complex-float64-ctor' ); var z1 = new Complex128( 1.0, 3.0 ); var z2 = new Complex128( 1.0+EPS, 3.0 ); var out = isAlmostEqual( z1, z2, 0 ); // returns false out = isAlmostEqual( z1, z2, 1 ); // returns true ``` The function returns `false` if either input value has a `NaN` real or imaginary component. ```javascript var Complex128 = require( '@stdlib/complex-float64-ctor' ); var z1 = new Complex128( NaN, 3.0 ); var z2 = new Complex128( 1.0, 3.0 ); var out = isAlmostEqual( z1, z2, 1 ); // returns false out = isAlmostEqual( z2, z1, 1 ); // returns false z1 = new Complex128( NaN, NaN ); z2 = new Complex128( NaN, NaN ); out = isAlmostEqual( z1, z2, 1 ); // returns false ``` The function does not distinguish between `-0` and `+0`, treating them as equal. ```javascript var Complex128 = require( '@stdlib/complex-float64-ctor' ); var z1 = new Complex128( 0.0, 0.0 ); var z2 = new Complex128( -0.0, -0.0 ); var out = isAlmostEqual( z1, z2, 0 ); // returns true ```
## Examples ```javascript var EPS = require( '@stdlib/constants-float64-eps' ); var Complex128 = require( '@stdlib/complex-float64-ctor' ); var isAlmostEqual = require( '@stdlib/complex-float64-base-assert-is-almost-equal' ); var z1 = new Complex128( 1.0, 3.0+EPS ); var z2 = new Complex128( 1.0+EPS, 3.0 ); console.log( isAlmostEqual( z1, z2, 1 ) ); // => true z1 = new Complex128( 1.0, 3.0+EPS ); z2 = new Complex128( 1.0+EPS+EPS, 3.0 ); console.log( isAlmostEqual( z1, z2, 1 ) ); // => false z1 = new Complex128( 0.0, 0.0 ); z2 = new Complex128( -0.0, 0.0 ); console.log( isAlmostEqual( z1, z2, 0 ) ); // => true z1 = new Complex128( NaN, 0.0 ); z2 = new Complex128( 1.0, 0.0 ); console.log( isAlmostEqual( z1, z2, 1 ) ); // => false ```
* * * ## Notice This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib]. #### Community [![Chat][chat-image]][chat-url] --- ## License See [LICENSE][stdlib-license]. ## Copyright Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].

Owner

  • Name: stdlib
  • Login: stdlib-js
  • Kind: organization

Standard library for JavaScript.

Citation (CITATION.cff) 

cff-version: 1.2.0
title: stdlib
message: >-
  If you use this software, please cite it using the
  metadata from this file.

type: software

authors:
  - name: The Stdlib Authors
    url: https://github.com/stdlib-js/stdlib/graphs/contributors

repository-code: https://github.com/stdlib-js/stdlib
url: https://stdlib.io

abstract: |
  Standard library for JavaScript and Node.js.

keywords:
  - JavaScript
  - Node.js
  - TypeScript
  - standard library
  - scientific computing
  - numerical computing
  - statistical computing

license: Apache-2.0 AND BSL-1.0

date-released: 2016

GitHub Events

Total
  • Member event: 1
  • Push event: 3
  • Create event: 4
Last Year
  • Member event: 1
  • Push event: 3
  • Create event: 4