[RFC]: add `@stdlib/assert/is-same-accessor-array`

[kgryte]

Description

This RFC proposes adding a new assertion package to test whether two arguments are both accessor arrays and have the same values.

Package: @stdlib/assert/is-same-accessor-array
Alias: isSameAccessorArray

Related Issues

No.

Questions

No.

Other

@stdlib/assert/is-same-array-like provides a reference implementation. One should only need to

• update descriptions
• use is-accessor-array
• update tests
• update examples and documentation

Checklist

• I have read and understood the Code of Conduct.
• Searched for existing issues and pull requests.
• The issue name begins with RFC:.

[stdlib-bot]

🚨 Important: PLEASE READ 🚨

This issue has been labeled as a good first issue and is available for anyone to work on.

If this is your first time contributing to an open source project, some aspects of the development process may seem unusual, arcane, or some combination of both.

1. You cannot "claim" issues. People new to open source often want to "claim" or be assigned an issue before beginning work. The typical rationale is that people want to avoid wasted work in the event that someone else ends up working the issue. However, this practice is not effective in open source, as it often leads to "issue squatting", in which an individual asks to be assigned, is granted their request, and then never ends up working on the issue. Accordingly, you are encouraged to communicate your intent to address this issue, ideally by providing a rough outline as to how you plan to address the issue or asking clarifying questions, but, at the end of the day, we will take running code and rough consensus in order to move forward quickly.
2. We have a very high bar for contributions. We have very high standards for contributions and expect all contributions—whether new features, tests, or documentation—to be rigorous, thorough, and complete. Once a pull request is merged into stdlib, that contribution immediately becomes the collective responsibility of all maintainers of stdlib. When we merge code into stdlib, we are saying that we, the maintainers, commit to reviewing subsequent changes and making bugfixes to the code. Hence, in order to ensure future maintainability, this naturally leads to a higher standard of contribution.

Before working on this issue and opening a pull request, please read the project's contributing guidelines. These guidelines and the associated development guide provide important information, including links to stdlib's Code of Conduct, license policy, and steps for setting up your local development environment.

To reiterate, we strongly encourage you to refer to our contributing guides before beginning work on this issue. Failure to follow our guidelines significantly decreases the likelihood that you'll successfully contribute to stdlib and may result in automatic closure of a pull request without review.

Setting up your local development environment is a critical first step, as doing so ensures that automated development processes for linting, license verification, and unit testing can run prior to authoring commits and pushing changes. If you would prefer to avoid manual setup, we provide pre-configured development containers for use locally or in GitHub Codespaces.

We place a high value on consistency throughout the stdlib codebase. We encourage you to closely examine other packages in stdlib and attempt to emulate the practices and conventions found therein.

• If you are attempting to contribute a new package, sometimes the best approach is to simply copy the contents of an existing package and then modify the minimum amount necessary to implement the feature (e.g., changing descriptions, parameter names, and implementation).
• If you are contributing tests, find a package implementing a similar feature and emulate the tests of that package.
• If you are updating documentation, examine several similar packages and emulate the content, style, and prose of those packages.

In short, the more effort you put in to ensure that your contribution looks and feels like stdlib—including variables names, bracket spacing, line breaks, etc—the more likely that your contribution will be reviewed and ultimately accepted. We encourage you to closely study the codebase before beginning work on this issue.

✨ Thank you again for your interest in stdlib, and we look forward to reviewing your future contributions. ✨

[aayush0325]

I've went through the codebase for similar packages and I'd love to work on this issue.

[aayush0325]

@example
var Complex128Array = require( '@stdlib/array/complex128' );
var isSameAccessorArray = require( '@stdlib/assert/is-same-accessor-array' );

var x = new Complex128Array( [ 1, 2, 1, 2 ] );
var y = new Complex128Array( [ 1, 2, 1, 2 ] );

var out = isSameAccessorArray( x, y );
// returns true

@example
var Complex128Array = require( '@stdlib/array/complex128' );
var isSameAccessorArray = require( '@stdlib/assert/is-same-accessor-array' );

var x = new Complex128Array( [ 1, 2, 1, 2 ] );
var y = new Complex128Array( [ 2, 1, 2, 1 ] );

var out = isSameAccessorArray( x, y );
// returns false

@example
var Complex128Array = require( '@stdlib/array/complex128' );
var isSameAccessorArray = require( '@stdlib/assert/is-same-accessor-array' );

var x = new Complex128Array( [ 1, 2, 1, 2 ] );
var y = [ 1, 2, 3 ];

var out = isSameAccessorArray( x, y );
// returns false

I've went through '@stdlib/assert/is-accessor-array' and i found out that only Complex64Array and Complex128Array are accepted as accessor arrays in '@stdlib/assert/is-accessor-array/test/test.js'

Based on that I've come up with these examples, I hope this is what you're looking for @kgryte. I have a basic patch ready for this feature and i can raise a PR soon if you're satisfied with this. I'd love to correct myself if you feel that this is not what you were looking for.

Note that I'm using Complex128Array and Complex64Array for writing tests and examples only, in the core feature my code applies the '@stdlib/assert/is-accessor-array' only so if there is any other way to make an accessor array that will give the expected response