# scopy
> Copy values from `x` into `y`.
## Usage
```javascript
var scopy = require( '@stdlib/blas/base/scopy' );
```
#### scopy( N, x, strideX, y, strideY )
Copies values from `x` into `y`.
```javascript
var Float32Array = require( '@stdlib/array/float32' );
var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
var y = new Float32Array( [ 6.0, 7.0, 8.0, 9.0, 10.0 ] );
scopy( x.length, x, 1, y, 1 );
// y => [ 1.0, 2.0, 3.0, 4.0, 5.0 ]
```
The function has the following parameters:
- **N**: number of indexed elements.
- **x**: input [`Float32Array`][mdn-float32array].
- **strideX**: index increment for `x`.
- **y**: output [`Float32Array`][mdn-float32array].
- **strideY**: index increment for `y`.
The `N` and stride parameters determine how values from `x` are copied into `y`. For example, to copy in reverse order every other value in `x` into the first `N` elements of `y`,
```javascript
var Float32Array = require( '@stdlib/array/float32' );
var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
var y = new Float32Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
scopy( 3, x, -2, y, 1 );
// y => [ 5.0, 3.0, 1.0, 10.0, 11.0, 12.0 ]
```
Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
```javascript
var Float32Array = require( '@stdlib/array/float32' );
// Initial arrays...
var x0 = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
var y0 = new Float32Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
// Create offset views...
var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
var y1 = new Float32Array( y0.buffer, y0.BYTES_PER_ELEMENT*3 ); // start at 4th element
// Copy in reverse order every other value from `x1` into `y1`...
scopy( 3, x1, -2, y1, 1 );
// y0 => [ 7.0, 8.0, 9.0, 6.0, 4.0, 2.0 ]
```
#### scopy.ndarray( N, x, strideX, offsetX, y, strideY, offsetY )
Copies values from `x` into `y` using alternative indexing semantics.
```javascript
var Float32Array = require( '@stdlib/array/float32' );
var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
var y = new Float32Array( [ 6.0, 7.0, 8.0, 9.0, 10.0 ] );
scopy.ndarray( x.length, x, 1, 0, y, 1, 0 );
// y => [ 1.0, 2.0, 3.0, 4.0, 5.0 ]
```
The function has the following additional parameters:
- **offsetX**: starting index for `x`.
- **offsetY**: starting index for `y`.
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example, to copy every other value in `x` starting from the second value into the last `N` elements in `y` where `x[i] = y[n]`, `x[i+2] = y[n-1]`,...,
```javascript
var Float32Array = require( '@stdlib/array/float32' );
var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
var y = new Float32Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
scopy.ndarray( 3, x, 2, 1, y, -1, y.length-1 );
// y => [ 7.0, 8.0, 9.0, 6.0, 4.0, 2.0 ]
```
## Notes
- If `N <= 0`, both functions return `y` unchanged.
- `scopy()` corresponds to the [BLAS][blas] level 1 function [`scopy`][scopy].
## Examples
```javascript
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var scopy = require( '@stdlib/blas/base/scopy' );
var opts = {
'dtype': 'float32'
};
var x = discreteUniform( 10, 0, 500, opts );
console.log( x );
var y = discreteUniform( x.length, 0, 255, opts );
console.log( y );
// Copy elements from `x` into `y` starting from the end of `y`:
scopy( x.length, x, 1, y, -1 );
console.log( y );
```
* * *
## C APIs
### Usage
```c
#include "stdlib/blas/base/scopy.h"
```
#### c_scopy( N, \*X, strideX, \*Y, strideY )
Copies values from `X` into `Y`.
```c
const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f };
float y[] = { 0.0f, 0.0f, 0.0f, 0.0f };
c_scopy( 4, x, 1, y, 1 );
```
The function accepts the following arguments:
- **N**: `[in] CBLAS_INT` number of indexed elements.
- **X**: `[in] float*` input array.
- **strideX**: `[in] CBLAS_INT` index increment for `X`.
- **Y**: `[out] float*` output array.
- **strideY**: `[in] CBLAS_INT` index increment for `Y`.
```c
void c_scopy( const CBLAS_INT N, const float *X, const CBLAS_INT strideX, float *Y, const CBLAS_INT strideY );
```
#### c_scopy_ndarray( N, \*X, strideX, offsetX, \*Y, strideY, offsetY )
Copies values from `x` into `y` using alternative indexing semantics.
```c
const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f, 5.0f };
float y[] = { 0.0f, 0.0f, 0.0f, 0.0f, 0.0f };
c_scopy_ndarray( 3, x, 1, 2, y, 1, 2 );
```
The function accepts the following arguments:
- **N**: `[in] CBLAS_INT` number of indexed elements.
- **X**: `[in] float*` input array.
- **strideX**: `[in] CBLAS_INT` index increment for `X`.
- **offsetX**: `[in] CBLAS_INT` starting index for `X`.
- **Y**: `[out] float*` output array.
- **strideY**: `[in] CBLAS_INT` index increment for `Y`.
- **offsetY**: `[in] CBLAS_INT` starting index for `Y`.
```c
void c_scopy_ndarray( const CBLAS_INT N, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, float *Y, const CBLAS_INT strideY, const CBLAS_INT offsetY );
```
### Examples
```c
#include "stdlib/blas/base/scopy.h"
#include
int main( void ) {
// Create strided arrays:
const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f, 5.0f, 6.0f, 7.0f, 8.0f };
float y[] = { 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f };
// Specify the number of elements:
const int N = 4;
// Specify stride lengths:
const int strideX = 2;
const int strideY = -2;
// Copy elements:
c_scopy( N, x, strideX, y, strideY );
// Print the result:
for ( int i = 0; i < 8; i++ ) {
printf( "y[ %i ] = %f\n", i, y[ i ] );
}
// Copy elements:
c_scopy_ndarray( N, x, strideX, 0, y, strideY, 6 );
// Print the result:
for ( int i = 0; i < 8; i++ ) {
printf( "y[ %i ] = %f\n", i, y[ i ] );
}
}
```
[blas]: http://www.netlib.org/blas
[scopy]: http://www.netlib.org/lapack/explore-html/df/d28/group__single__blas__level1.html
[mdn-float32array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float32Array
[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
[@stdlib/blas/base/dcopy]: https://github.com/stdlib-js/blas/tree/main/base/dcopy
[@stdlib/blas/base/gcopy]: https://github.com/stdlib-js/blas/tree/main/base/gcopy
[@stdlib/blas/base/sswap]: https://github.com/stdlib-js/blas/tree/main/base/sswap