Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,136 @@
<!--

@license Apache-2.0

Copyright (c) 2026 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.

-->

# drightPadEdge

> Append elements to a one-dimensional double-precision floating-point input ndarray by repeating the trailing edge element and write the results to a one-dimensional double-precision floating-point output ndarray.

<section class="intro">

</section>

<!-- /.intro -->

<section class="usage">

## Usage

```javascript
var drightPadEdge = require( '@stdlib/blas/ext/base/ndarray/dright-pad-edge' );
```

#### drightPadEdge( arrays )

Appends elements to a one-dimensional double-precision floating-point input ndarray by repeating the trailing edge element and writes the results to a one-dimensional double-precision floating-point output ndarray.

```javascript
var Float64Vector = require( '@stdlib/ndarray/vector/float64' );
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
var zeros = require( '@stdlib/ndarray/zeros' );

var x = new Float64Vector( [ 1.0, 2.0, 3.0, 4.0 ] );
var y = zeros( [ 10 ], {
'dtype': 'float64'
});

var k = scalar2ndarray( 6, {
'dtype': 'generic'
});

var out = drightPadEdge( [ x, y, k ] );
// returns <ndarray>[ 1.0, 2.0, 3.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0 ]

var bool = ( out === y );
// returns true
```

The function has the following parameters:

- **arrays**: array-like object containing the following ndarrays:

- a one-dimensional input ndarray.
- a one-dimensional output ndarray. Must have `N + k` elements, where `N` is the number of elements in the input ndarray, and `k` is the number of elements to pad.
- a zero-dimensional ndarray specifying the number of elements to pad.

</section>

<!-- /.usage -->

<section class="notes">

## Notes

- If the input ndarray is empty, the function returns the output ndarray unchanged.
- If the number of elements to pad is less than zero, the function copies elements from the input ndarray to the output ndarray without padding.

</section>

<!-- /.notes -->

<section class="examples">

## Examples

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

```javascript
var discreteUniform = require( '@stdlib/random/discrete-uniform' );
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
var ndarray2array = require( '@stdlib/ndarray/to-array' );
var zeros = require( '@stdlib/ndarray/zeros' );
var drightPadEdge = require( '@stdlib/blas/ext/base/ndarray/dright-pad-edge' );

var opts = {
'dtype': 'float64'
};

var x = discreteUniform( [ 10 ], -100, 100, opts );
console.log( ndarray2array( x ) );

var k = scalar2ndarray( 5, {
'dtype': 'generic'
});

var y = zeros( [ 15 ], opts );
console.log( ndarray2array( y ) );

var v = drightPadEdge( [ x, y, k ] );
console.log( ndarray2array( v ) );
```

</section>

<!-- /.examples -->

<!-- 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 -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2026 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/uniform' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var pow = require( '@stdlib/math/base/special/pow' );
var zeros = require( '@stdlib/ndarray/zeros' );
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
var format = require( '@stdlib/string/format' );
var pkg = require( './../package.json' ).name;
var drightPadEdge = require( './../lib' );


// VARIABLES //

var options = {
'dtype': 'float64'
};


// FUNCTIONS //

/**
* Creates a benchmark function.
*
* @private
* @param {PositiveInteger} len - array length
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var x;
var y;
var k;

x = uniform( [ len ], 0.0, 100.0, options );
y = zeros( [ len+5 ], options );
k = scalar2ndarray( 5, {
'dtype': 'generic'
});

return benchmark;

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

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
out = drightPadEdge( [ x, y, k ] );
if ( typeof out !== 'object' ) {
b.fail( 'should return an ndarray' );
}
}
b.toc();
if ( isnan( out.get( i%( len+5 ) ) ) ) {
b.fail( 'should not return NaN' );
}
b.pass( 'benchmark finished' );
b.end();
}
}


// MAIN //

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

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

for ( i = min; i <= max; i++ ) {
len = pow( 10, i );
f = createBenchmark( len );
bench( format( '%s:len=%d', pkg, len ), f );
}
}

main();
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@

{{alias}}( arrays )
Appends elements to a one-dimensional double-precision floating-point input
ndarray by repeating the trailing edge element and writes the results to a
one-dimensional double-precision floating-point output ndarray.

If the input ndarray is empty, the function returns the output ndarray
unchanged.

If the number of elements to pad is less than zero, the function copies
elements from the input ndarray to the output ndarray without padding.

Parameters
----------
arrays: ArrayLikeObject<ndarray>
Array-like object containing the following ndarrays:

- a one-dimensional input ndarray.
- a one-dimensional output ndarray. Must have `N + k` elements, where
`N` is the number of elements in the input ndarray, and `k` is the
number of elements to pad.
- a zero-dimensional ndarray specifying the number of elements to pad.

Returns
-------
out: ndarray
Output ndarray.

Examples
--------
> var x = {{alias:@stdlib/ndarray/vector/float64}}( [ 1.0, 2.0, 3.0, 4.0 ] );
> var opts = { 'dtype': 'float64' };
> var y = {{alias:@stdlib/ndarray/zeros}}( [ 10 ], opts );
> var k = {{alias:@stdlib/ndarray/from-scalar}}( 6, { 'dtype': 'generic' } );
> {{alias}}( [ x, y, k ] )
<ndarray>[ 1.0, 2.0, 3.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0 ]

See Also
--------
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
/*
* @license Apache-2.0
*
* Copyright (c) 2026 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 { float64ndarray, typedndarray } from '@stdlib/types/ndarray';

/**
* Appends elements to a one-dimensional double-precision floating-point input ndarray by repeating the trailing edge element and writes the results to a one-dimensional double-precision floating-point output ndarray.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - a one-dimensional input ndarray.
* - a one-dimensional output ndarray. Must have `N + k` elements, where `N` is the number of elements in the input ndarray, and `k` is the number of elements to pad.
* - a zero-dimensional ndarray specifying the number of elements to pad.
*
* @param arrays - array-like object containing ndarrays
* @returns output ndarray
*
* @example
* var Float64Vector = require( '@stdlib/ndarray/vector/float64' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
* var zeros = require( '@stdlib/ndarray/zeros' );
*
* var x = new Float64Vector( [ 1.0, 2.0, 3.0, 4.0 ] );
* var y = zeros( [ 10 ], {
* 'dtype': 'float64'
* });
*
* var k = scalar2ndarray( 6, {
* 'dtype': 'generic'
* });
*
* var out = drightPadEdge( [ x, y, k ] );
* // returns <ndarray>[ 1.0, 2.0, 3.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0, 4.0 ]
*/
declare function drightPadEdge( arrays: [ float64ndarray, float64ndarray, typedndarray<number> ] ): float64ndarray;


// EXPORTS //

export = drightPadEdge;
Loading
Loading