Skip to content

Commit

Permalink
Auto-generated commit
Browse files Browse the repository at this point in the history
  • Loading branch information
stdlib-bot committed Nov 23, 2023
1 parent eda74c5 commit 34deefa
Show file tree
Hide file tree
Showing 13 changed files with 665 additions and 5 deletions.
110 changes: 110 additions & 0 deletions base/fliplr2d/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
<!--
@license Apache-2.0
Copyright (c) 2023 The Stdlib Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->

# fliplr2d

> Reverse the order of elements along the last dimension of a two-dimensional nested input array.
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->

<section class="intro">

</section>

<!-- /.intro -->

<!-- Package usage documentation. -->

<section class="usage">

## Usage

```javascript
var fliplr2d = require( '@stdlib/array/base/fliplr2d' );
```

#### fliplr2d( x )

Reverses the order of elements along the last dimension of a two-dimensional nested input array.

```javascript
var out = fliplr2d( [ [ 1, 2 ], [ 3, 4 ] ] );
// returns [ [ 2, 1 ], [ 4, 3 ] ]
```

</section>

<!-- /.usage -->

<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="notes">

</section>

<!-- /.notes -->

<!-- Package usage examples. -->

<section class="examples">

## Examples

<!-- eslint no-undef: "error" -->

```javascript
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
var filled2dBy = require( '@stdlib/array/base/filled2d-by' );
var fliplr2d = require( '@stdlib/array/base/fliplr2d' );

var x = filled2dBy( [ 3, 3 ], discreteUniform( -50, 50 ) );
console.log( x );

var y = fliplr2d( x );
console.log( y );
```

</section>

<!-- /.examples -->

<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="references">

</section>

<!-- /.references -->

<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->

<section class="related">

</section>

<!-- /.related -->

<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="links">

</section>

<!-- /.links -->
107 changes: 107 additions & 0 deletions base/fliplr2d/benchmark/benchmark.size.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2023 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

'use strict';

// MODULES //

var bench = require( '@stdlib/bench' );
var uniform = require( '@stdlib/random/base/uniform' ).factory;
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var pow = require( '@stdlib/math/base/special/pow' );
var floor = require( '@stdlib/math/base/special/floor' );
var filled2dBy = require( './../../../base/filled2d-by' );
var numel = require( '@stdlib/ndarray/base/numel' );
var pkg = require( './../package.json' ).name;
var fliplr2d = require( './../lib' );


// FUNCTIONS //

/**
* Creates a benchmark function.
*
* @private
* @param {PositiveIntegerArray} shape - array shape
* @returns {Function} benchmark function
*/
function createBenchmark( shape ) {
var x = filled2dBy( shape, uniform( -100.0, 100.0 ) );
return benchmark;

/**
* Benchmark function.
*
* @private
* @param {Benchmark} b - benchmark instance
*/
function benchmark( b ) {
var out;
var i0;
var i1;
var i;

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
out = fliplr2d( x );
i1 = i % shape[ 0 ];
i0 = i % shape[ 1 ];
if ( isnan( out[ i1 ][ i0 ] ) ) {
b.fail( 'should not return NaN' );
}
}
b.toc();

i1 = i % shape[ 0 ];
i0 = i % shape[ 1 ];
if ( isnan( out[ i1 ][ i0 ] ) ) {
b.fail( 'should not return NaN' );
}
b.pass( 'benchmark finished' );
b.end();
}
}


// MAIN //

/**
* Main execution sequence.
*
* @private
*/
function main() {
var min;
var max;
var sh;
var N;
var f;
var i;

min = 1; // 10^min
max = 6; // 10^max

for ( i = min; i <= max; i++ ) {
N = floor( pow( pow( 10, i ), 1.0/2.0 ) );
sh = [ N, N ];
f = createBenchmark( sh );
bench( pkg+'::square_matrix:size='+numel( sh ), f );
}
}

main();
25 changes: 25 additions & 0 deletions base/fliplr2d/docs/repl.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@

{{alias}}( x )
Reverses the order of elements along the last dimension of a two-dimensional
nested input array.

The function does *not* perform a deep copy of nested array elements.

Parameters
----------
x: ArrayLikeObject
Input nested array.

Returns
-------
out: Array
Output array.

Examples
--------
> var out = {{alias}}( [ [ 1, 2 ], [ 3, 4 ] ] )
[ [ 2, 1 ], [ 4, 3 ] ]

See Also
--------

46 changes: 46 additions & 0 deletions base/fliplr2d/docs/types/index.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
/*
* @license Apache-2.0
*
* Copyright (c) 2023 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

// TypeScript Version: 4.1

/// <reference types="@stdlib/types"/>

import { Array2D } from '@stdlib/types/array';

/**
* Reverses the order of elements along the last dimension of a two-dimensional nested input array.
*
* ## Notes
*
* - The function does **not** perform a deep copy of nested array elements.
*
* @param x - input nested array
* @returns output array
*
* @example
* var x = [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ];
*
* var out = fliplr2d( x );
* // returns [ [ 2, 1 ], [ 4, 3 ], [ 6, 5 ] ]
*/
declare function fliplr2d<T = unknown>( x: Array2D<T> ): Array2D<T>;


// EXPORTS //

export = fliplr2d;
48 changes: 48 additions & 0 deletions base/fliplr2d/docs/types/test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
/*
* @license Apache-2.0
*
* Copyright (c) 2023 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

import fliplr2d = require( './index' );


// TESTS //

// The function returns an array of arrays...
{
const x = [ [ 1, 2 ], [ 3, 4 ] ];

fliplr2d( x ); // $ExpectType Array2D<number>
}

// The compiler throws an error if the function is provided a first argument which is not a nested array...
{
fliplr2d( 'abc' ); // $ExpectError
fliplr2d( 1 ); // $ExpectError
fliplr2d( true ); // $ExpectError
fliplr2d( false ); // $ExpectError
fliplr2d( null ); // $ExpectError
fliplr2d( {} ); // $ExpectError
fliplr2d( ( x: number ): number => x ); // $ExpectError
}

// The compiler throws an error if the function is provided an unsupported number of arguments...
{
const x = [ [ 1, 2 ], [ 3, 4 ] ];

fliplr2d(); // $ExpectError
fliplr2d( x, 2 ); // $ExpectError
}
29 changes: 29 additions & 0 deletions base/fliplr2d/examples/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2023 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

'use strict';

var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
var filled2dBy = require( './../../../base/filled2d-by' );
var fliplr2d = require( './../lib' );

var x = filled2dBy( [ 3, 3 ], discreteUniform( -50, 50 ) );
console.log( x );

var y = fliplr2d( x );
console.log( y );
Loading

0 comments on commit 34deefa

Please sign in to comment.