compute-fliplr
v1.0.0
Published
Flips a matrix horizontally.
Downloads
16
Maintainers
Readme
fliplr
Flips a matrix horizontally.
Installation
$ npm install compute-fliplr
For use in the browser, use browserify.
Usage
var fliplr = require( 'compute-fliplr' );
fliplr( x[, opts] )
Flips a matrix horizontally.
var matrix = require( 'dstructs-matrix' );
var mat = matrix( [2,3] );
mat.set( 0, 2, 5 ).set( 1, 2, 6 );
/*
[ 0 0 5
0 0 6 ]
*/
var lr = fliplr( mat );
/*
[ 5 0 0
6 0 0 ]
*/
By default, the function returns a new matrix instance. To mutate the input matrix, set the copy
option to false
.
var lr = fliplr( mat, {
'copy': false
});
/*
[ 5 0 0
6 0 0 ]
*/
var bool = ( mat === lr );
// returns true
Examples
var matrix = require( 'dstructs-matrix' ),
fliplr = require( 'compute-fliplr' );
var data,
mat,
lr, i;
data = new Int8Array( 10 );
for ( i = 0; i < data.length; i++ ) {
data[ i ] = i;
}
mat = matrix( data, [5,2], 'int8' );
/*
[ 0 1
2 3
4 5
6 7
8 9 ]
*/
lr = fliplr( mat );
/*
[ 1 0
3 2
5 4
7 6
9 8 ]
*/
To run the example code from the top-level application directory,
$ node ./examples/index.js
Tests
Unit
Unit tests use the Mocha test framework with Chai assertions. To run the tests, execute the following command in the top-level application directory:
$ make test
All new feature development should have corresponding unit tests to validate correct functionality.
Test Coverage
This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:
$ make test-cov
Istanbul creates a ./reports/coverage
directory. To access an HTML version of the report,
$ make view-cov
License
Copyright
Copyright © 2015. The Compute.io Authors.