compute-transpose v1.0.0

Transpose

Computes the transpose of a matrix.

Installation

$ npm install compute-transpose

For use in the browser, use browserify.

Usage

var transpose = require( 'compute-transpose' );

transpose( x, opts )

Computes the transpose of a matrix.

var matrix = require( 'dstructs-matrix' );

var mat = matrix( [2,3] );
/*
	[ 0 0 0
	  0 0 0 ]
*/

var t = transpose( mat );
/*
	[ 0 0
	  0 0
	  0 0 ]
*/

By default, the function returns a new matrix instance. To mutate the input matrix, set the copy option to false.

var t = transpose( mat, {
	'copy': false
});
/*
	[ 0 0
	  0 0
	  0 0 ]
*/

var bool = ( mat === t );
// returns true

Examples

var matrix = require( 'dstructs-matrix' ),
	transpose = require( 'compute-transpose' );

var data,
	mat,
	t, 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 ]
*/

t = transpose( mat );
/*
	[ 0 2 4 6 8
	  1 3 5 7 9 ]
*/

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

MIT license.

Copyright

Copyright © 2015. The Compute.io Authors.