Nearly Equal

A function to compare Float without worry about something like 0.1 + 0.2 != 0.3

Installation

1. Install in your project

   npm i @intocode-io/nearly-equal

2. Import the code

   import nearlyEqual from '@intocode-io/nearly-equal';

   Or

   const nearlyEqual = require('@intocode-io/nearly-equal');

Usage

Problem

The problem occurs when you try to compare Float variables

0.1 + 0.2 === 0.3 // false

Because 0.1 + 0.2 in many programming language including JavaScript is 0.30000000000000004

0.1 + 0.2 // 0.30000000000000004

Solution

nearlyEqual can help you

nearlyEqual(0.1 + 0.2, 0.3); // true

Attribution

"The Floating Point Guide, Comparison" by Michael Borgwardt. TypeScript source code in this repository is followed the logics provided in the article.

License

Copyright © 2018 intocode Co., Ltd.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.