# math-floor

> Rounds a numeric value toward negative infinity.

Latest version **1.0.1** (published 2016-01-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install math-floor
pnpm add math-floor
yarn add math-floor
bun add math-floor
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2016-01-13 |
| First published | 2016-01-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Athan Reines |
| Maintainers | kgryte |
| Keywords | compute.io, compute-io, compute, computation, math.io, math-io, math, mathematics, math.floor, floor, round, integer, nearest, value, scalar, number |

## Links

- npm: https://www.npmjs.com/package/math-floor
- Repository: https://github.com/math-io/floor
- Homepage: https://github.com/math-io/floor#readme
- Issues: https://github.com/math-io/floor/issues
- npm.io page: https://npm.io/package/math-floor

## Alternatives

- [random-seedable](https://npm.io/package/random-seedable.md) — 27.9K weekly downloads
- [n2words](https://npm.io/package/n2words.md) — 22.2K weekly downloads
- [@stdlib/math-base-special-factorialln](https://npm.io/package/@stdlib/math-base-special-factorialln.md) — 5.7K weekly downloads
- [@stdlib/math-base-special-abs2](https://npm.io/package/@stdlib/math-base-special-abs2.md) — 1.7K weekly downloads
- [commons-math-interpolation](https://npm.io/package/commons-math-interpolation.md) — 1.4K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2016-01-13
- 1.0.0 — 2016-01-12
- 0.0.0 — 2016-01-12

## README

Floor
===
[![NPM version][npm-image]][npm-url] [![Build Status][build-image]][build-url] [![Coverage Status][coverage-image]][coverage-url] [![Dependencies][dependencies-image]][dependencies-url]

> Rounds a numeric value toward negative infinity.


## Installation

``` bash
$ npm install math-floor
```


## Usage

``` javascript
var floor = require( 'math-floor' );
```

#### floor( x )

Rounds a `numeric` value toward negative infinity.

``` javascript
var val = floor( -4.2 );
// returns -5

val = floor( 9.99999 );
// returns 9

val = floor( 0 );
// returns 0
```


## Examples

``` javascript
var floor = require( 'math-floor' );

var x;
var i;

for ( i = 0; i < 100; i++ ) {
	x = Math.random()*100 - 50;
	console.log( 'Value: %d. Floored: %d.', x, floor( x ) );
}
```

To run the example code from the top-level application directory,

``` bash
$ node ./examples/index.js
```


---
## Tests

### Unit

This repository uses [tape][tape] for unit tests. To run the tests, execute the following command in the top-level application directory:

``` bash
$ make test
```

All new feature development should have corresponding unit tests to validate correct functionality.


### Test Coverage

This repository uses [Istanbul][istanbul] as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:

``` bash
$ make test-cov
```

Istanbul creates a `./reports/coverage` directory. To access an HTML version of the report,

``` bash
$ make view-cov
```


### Browser Support

This repository uses [Testling][testling] for browser testing. To run the tests in a (headless) local web browser, execute the following command in the top-level application directory:

``` bash
$ make test-browsers
```

To view the tests in a local web browser,

``` bash
$ make view-browser-tests
```

<!-- [![browser support][browsers-image]][browsers-url] -->


---
## License

[MIT license](http://opensource.org/licenses/MIT).


## Copyright

Copyright &copy; 2016. The [Compute.io][compute-io] Authors.


[npm-image]: http://img.shields.io/npm/v/math-floor.svg
[npm-url]: https://npmjs.org/package/math-floor

[build-image]: http://img.shields.io/travis/math-io/floor/master.svg
[build-url]: https://travis-ci.org/math-io/floor

[coverage-image]: https://img.shields.io/codecov/c/github/math-io/floor/master.svg
[coverage-url]: https://codecov.io/github/math-io/floor?branch=master

[dependencies-image]: http://img.shields.io/david/math-io/floor.svg
[dependencies-url]: https://david-dm.org/math-io/floor

[dev-dependencies-image]: http://img.shields.io/david/dev/math-io/floor.svg
[dev-dependencies-url]: https://david-dm.org/dev/math-io/floor

[github-issues-image]: http://img.shields.io/github/issues/math-io/floor.svg
[github-issues-url]: https://github.com/math-io/floor/issues

[tape]: https://github.com/substack/tape
[istanbul]: https://github.com/gotwarlost/istanbul
[testling]: https://ci.testling.com

[compute-io]: https://github.com/compute-io/

---
_Source: https://npm.io/package/math-floor · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._