feat: add assert/is-complex-string
#1417
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kgryte
changed the title
assert/is-complex-string
kgryte
added
Feature
|
please review @Planeshifter |
Pranavchiku
requested changes
Mar 1, 2024
|
|
||
| # isComplexString | ||
|
|
||
| > Tests whether input string is a complex number representation`. |
There was a problem hiding this comment.
Suggested change
| > Tests whether input string is a complex number representation`. | |
| > Tests whether input string is a complex number representation. |
|
|
||
| #### isComplexString( str ) | ||
|
|
||
| Tests whether input string is a complex number representation`. |
There was a problem hiding this comment.
Suggested change
| Tests whether input string is a complex number representation`. | |
| Tests whether input string is a complex number representation. |
|
|
||
| ## Usage | ||
|
|
||
| ```js |
There was a problem hiding this comment.
Suggested change
| ```js | |
| ```javascript |
|
|
||
| Tests whether input string is a complex number representation`. | ||
|
|
||
| ```js |
There was a problem hiding this comment.
Suggested change
| ```js | |
| ```javascript |
|
|
||
| <!-- eslint no-undef: "error" --> | ||
|
|
||
| ```js |
| // MODULES // | ||
|
|
||
| var isString = require( '@stdlib/assert/is-string' ); | ||
| var parse = require( '@stdlib/complex/base/parse'); |
There was a problem hiding this comment.
Suggested change
| var parse = require( '@stdlib/complex/base/parse'); | |
| var parse = require( '@stdlib/complex/base/parse' ); |
| * Test whether input string is a complex number representation. | ||
| * | ||
| * @param {string} str - input string | ||
| * @returns {boolean} a boolean indicated if the string is a valid complex number representation. |
There was a problem hiding this comment.
Suggested change
| * @returns {boolean} a boolean indicated if the string is a valid complex number representation. | |
| * @returns {boolean} a boolean indicated if the string is a valid complex number representation |
| * @example | ||
| * var str = '4 + 6i'; | ||
| * | ||
| * var isCmplx = isComplexString( str ); |
There was a problem hiding this comment.
Suggested change
| * var isCmplx = isComplexString( str ); | |
| * var v = isComplexString( str ); |
| '0+1i', | ||
| '-0.0 + 2.0i', | ||
| '-Infinity + 5i', | ||
|
|
| '-Infinity + 5i', | ||
|
|
||
| 'Infinity-Infinityi' | ||
|
|
Pranavchiku
added
Needs Changes
Planeshifter
changed the title
assert/is-complex-stringassert/is-complex-string
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #1370
Description
This PR adds the package @stdlib/assert/is-complex-string
The package implements assertion for a string represeting a complex number.
Alias: isComplexString
Related Issues
This pull request:
@stdlib/assert/is-complex-string#1370Checklist
@stdlib-js/reviewers