Skip to content

Commit

Permalink
feat: add array/base/count-same-value
Browse files Browse the repository at this point in the history
Closes: #1325
PR-URL: 	#1339
Co-authored-by: Athan Reines <kgryte@gmail.com>
Reviewed-by: Athan Reines <kgryte@gmail.com> 
Signed-off-by: Athan Reines <kgryte@gmail.com>
  • Loading branch information
skoriop and kgryte authored Feb 22, 2024
1 parent 8887063 commit 634044b
Show file tree
Hide file tree
Showing 10 changed files with 812 additions and 0 deletions.
111 changes: 111 additions & 0 deletions lib/node_modules/@stdlib/array/base/count-same-value/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
<!--
@license Apache-2.0
Copyright (c) 2024 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.
-->

# countSameValue

> Count the number of elements that are equal to a given value in an 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 countSameValue = require( '@stdlib/array/base/count-same-value' );
```

#### countSameValue( x, value )

Counts the number of elements that are equal to a given value in an array.

```javascript
var x = [ 0, 1, 0, 1, 2 ];

var out = countSameValue( x, 1 );
// returns 2
```

</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 sample = require( '@stdlib/random/sample' );
var countSameValue = require( '@stdlib/array/base/count-same-value' );

var x = sample( [ 1, 2, 3, 4, 5 ] );
console.log( x );

var n = countSameValue( x, 1 );
console.log( n );
```

</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 -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2024 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 pow = require( '@stdlib/math/base/special/pow' );
var isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ).isPrimitive;
var ones = require( '@stdlib/array/base/ones' );
var pkg = require( './../package.json' ).name;
var countSameValue = require( './../lib' );


// FUNCTIONS //

/**
* Creates a benchmark function.
*
* @private
* @param {PositiveInteger} len - array length
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var x = ones( len );
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 = countSameValue( x, 1 );
if ( typeof out !== 'number' ) {
b.fail( 'should return a number' );
}
}
b.toc();
if ( !isNonNegativeInteger( out ) ) {
b.fail( 'should return a nonnegative integer' );
}
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( pkg+':dtype=generic,len='+len, f );
}
}

main();
25 changes: 25 additions & 0 deletions lib/node_modules/@stdlib/array/base/count-same-value/docs/repl.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@

{{alias}}( x, value )
Counts the number of elements that are equal to a given value in an array.

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

value: any
Input value.

Returns
-------
out: integer
Number of elements that are equal to the given value.

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

See Also
--------

Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
/*
* @license Apache-2.0
*
* Copyright (c) 2024 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 { Collection } from '@stdlib/types/array';

/**
* Counts the number of elements that are equal to a given value in an array.
*
* @param x - input array
* @param value - given value
* @returns number of elements that are equal to the given value
*
* @example
* var x = [ 0, 1, 0, 1, 1 ];
*
* var out = countSameValue( x, 1 );
* // returns 3
*/
declare function countSameValue( x: Collection, value: any ): number;

Check warning on line 38 in lib/node_modules/@stdlib/array/base/count-same-value/docs/types/index.d.ts

View workflow job for this annotation

GitHub Actions / Lint Changed Files

Unexpected any. Specify a different type


// EXPORTS //

export = countSameValue;
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
/*
* @license Apache-2.0
*
* Copyright (c) 2024 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 countSameValue = require( './index' );


// TESTS //

// The function returns a number...
{
countSameValue( [ 1, 2, 3 ], 1 ); // $ExpectType number
}

// The compiler throws an error if the first argument is not a collection...
{
countSameValue( 5, 1 ); // $ExpectError
countSameValue( true, 1 ); // $ExpectError
countSameValue( false, 1 ); // $ExpectError
countSameValue( null, 1 ); // $ExpectError
countSameValue( {}, 1 ); // $ExpectError
}

// The compiler throws an error if the function is provided an unsupported number of arguments...
{
countSameValue(); // $ExpectError
countSameValue( [ 1, 2, 3 ] ); // $ExpectError
countSameValue( [ 1, 2, 3 ], 2, 3 ); // $ExpectError
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2024 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 sample = require( '@stdlib/random/sample' );
var countSameValue = require( './../lib' );

var x = sample( [ 1, 2, 3, 4, 5 ] );
console.log( x );

var n = countSameValue( x, 1 );
console.log( n );
42 changes: 42 additions & 0 deletions lib/node_modules/@stdlib/array/base/count-same-value/lib/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2024 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';

/**
* Count the number of elements that are equal to a given value in an array.
*
* @module @stdlib/array/base/count-same-value
*
* @example
* var countSameValue = require( '@stdlib/array/base/count-same-value' );
*
* var x = [ 0, 1, 0, 1, 1 ];
*
* var n = countSameValue( x, 1 );
* // returns 3
*/

// MODULES //

var main = require( './main.js' );


// EXPORTS //

module.exports = main;
Loading

1 comment on commit 634044b

@stdlib-bot
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage Report

Package Statements Branches Functions Lines
array/base/count-same-value $\color{red}205/207$
$\color{green}+99.03\%$
$\color{red}15/16$
$\color{green}+93.75\%$
$\color{green}4/4$
$\color{green}+100.00\%$
$\color{red}205/207$
$\color{green}+99.03\%$

The above coverage report was generated for the changes in this push.

Please sign in to comment.