Add package to split a string into array of sentences

Author: Planeshifter

lib/node_modules/@stdlib/nlp/sentencize/README.md

@@ -0,0 +1,103 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2023 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.
+
+-->
+
+# sentencize
+
+> Split a string into an array of sentences.
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var sentencize = require( '@stdlib/nlp/sentencize' );
+```
+
+#### sentencize( str )
+
+Splits a string into an array of sentences.
+
+```javascript
+var str = 'Hello Mrs. Maple, could you call me back? I need to talk to you about something.';
+var out = sentencize( str );
+// returns  [ 'Hello Mrs. Maple, could you call me back?', 'I need to talk to you about something.' ]
+
+str = 'As of 2.14.2023, the average price of apples is $1.31 per pound! Inflation has been a strain on the economy.';
+out = sentencize( str );
+// returns [ 'As of 2.14.2023, the average price of apples is $1.31 per pound!', 'Inflation has been a strain on the economy.' ]
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var sentencize = require( '@stdlib/nlp/sentencize' );
+
+var sentences = [
+    'Dr. John Smith, Jr. who is a renowned expert in the field of Artificial Intelligence, and who has published numerous papers on the subject, e.g. "Machine Learning for Dummies", "The Future of AI", etc., gave a lecture at the annual AI conference yesterday and stated that AI technology is rapidly advancing, but we must be cautious of its potential consequences such as job displacement, privacy concerns, and ethical dilemmas.',
+    'In addition, AI also has many benefits such as improved efficiency and accuracy, and the ability to process large amounts of data.',
+    'Dr. Smith emphasized that it is crucial for society to have open and honest discussions about the development and deployment of AI to ensure its responsible and beneficial use for all.',
+    'He also stressed the importance of considering the implications and consequences of AI, i.e. it must not be developed or used in a way that is harmful or unethical.',
+    'The audience was in agreement, nodding their heads and taking notes throughout the lecture.'
+];
+var str = sentences.join( ' ' );
+
+var out = sentencize( str );
+// returns [...]
+
+var bool = ( out.length === 5 );
+// returns true
+
+bool = ( out[ 0 ] === sentences[ 0 ] );
+// returns true
+```
+
+</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 -->

lib/node_modules/@stdlib/nlp/sentencize/benchmark/benchmark.js

@@ -0,0 +1,54 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2023 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 isArray = require( '@stdlib/assert/is-array' );
+var fromCodePoint = require( '@stdlib/string/from-code-point' );
+var pkg = require( './../package.json' ).name;
+var sentencize = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg, function benchmark( b ) {
+	var speech;
+	var out;
+	var str;
+	var i;
+
+	speech = 'To be, or not to be, that is the question. Whether tis nobler in the mind to suffer. The slings and arrows of outrageous fortune. Or to take arms against a sea of troubles. And by opposing end them. To die, to sleep, no more.';
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		str = speech + '(' + fromCodePoint( i%126 ) + ')';
+		out = sentencize( str );
+		if ( typeof out !== 'object' ) {
+			b.fail( 'should return an array' );
+		}
+	}
+	b.toc();
+	if ( !isArray( out ) ) {
+		b.fail( 'should return an array' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

lib/node_modules/@stdlib/nlp/sentencize/docs/repl.txt

@@ -0,0 +1,25 @@
+
+{{alias}}( str )
+    Splits a string into an array of sentences.
+
+    Parameters
+    ----------
+    str: string
+        Input string.
+
+    Returns
+    -------
+    out: Array
+        Array of sentences.
+
+    Examples
+    --------
+    > var out = {{alias}}( 'Hello Mrs. Maple, could you call me back?' )
+    [ 'Hello Mrs. Maple, could you call me back?' ]
+
+    > out = {{alias}}( 'Hello World! How are you?' )
+    [ 'Hello World!', 'How are you?' ]
+
+    See Also
+    --------
+

lib/node_modules/@stdlib/nlp/sentencize/docs/types/index.d.ts

@@ -0,0 +1,47 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2023 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: 2.0
+
+/**
+* Splits a string into an array of sentences.
+*
+* @param str - input string
+* @returns array of sentences
+*
+* @example
+* var str = 'Hello World! How are you?';
+* var out = sentencize( str );
+* // returns [ 'Hello World!', 'How are you?' ]
+*
+* @example
+* var str = '';
+* var out = sentencize( str );
+* // returns []
+*
+* @example
+* var str = 'Hello Mrs. Maple, could you call me back?';
+* var out = sentencize( str );
+* // returns [ 'Hello Mrs. Maple, could you call me back?' ]
+*/
+declare function sentencize( str: string ): Array<string>;
+
+
+// EXPORTS //
+
+export = sentencize;

lib/node_modules/@stdlib/nlp/sentencize/docs/types/test.ts

@@ -0,0 +1,42 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2023 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 sentencize = require( './index' );
+
+
+// TESTS //
+
+// The function returns an array of strings...
+{
+	sentencize( 'Hello World! How are you?' ); // $ExpectType string[]
+}
+
+// The compiler throws an error if the function is provided values of invalid types...
+{
+	sentencize( true ); // $ExpectError
+	sentencize( false ); // $ExpectError
+	sentencize( 3 ); // $ExpectError
+	sentencize( [] ); // $ExpectError
+	sentencize( {} ); // $ExpectError
+	sentencize( ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided insufficient arguments...
+{
+	sentencize(); // $ExpectError
+}

lib/node_modules/@stdlib/nlp/sentencize/examples/index.js

@@ -0,0 +1,42 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2023 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 sentencize = require( './../lib' );
+
+var sentences = [
+	'Dr. John Smith, Jr. who is a renowned expert in the field of Artificial Intelligence, and who has published numerous papers on the subject, e.g. "Machine Learning for Dummies", "The Future of AI", etc., gave a lecture at the annual AI conference yesterday and stated that AI technology is rapidly advancing, but we must be cautious of its potential consequences such as job displacement, privacy concerns, and ethical dilemmas.',
+	'In addition, AI also has many benefits such as improved efficiency and accuracy, and the ability to process large amounts of data.',
+	'Dr. Smith emphasized that it is crucial for society to have open and honest discussions about the development and deployment of AI to ensure its responsible and beneficial use for all.',
+	'He also stressed the importance of considering the implications and consequences of AI, i.e. it must not be developed or used in a way that is harmful or unethical.',
+	'The audience was in agreement, nodding their heads and taking notes throughout the lecture.'
+];
+var str = sentences.join( ' ' );
+
+var out = sentencize( str );
+console.log( out );
+// => [...]
+
+var bool = ( out.length === 5 );
+console.log( bool );
+// => true
+
+bool = ( out[ 0 ] === sentences[ 0 ] );
+console.log( bool );
+// => true

lib/node_modules/@stdlib/nlp/sentencize/lib/index.js

@@ -0,0 +1,41 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2023 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';
+
+/**
+* Split a string into an array of sentences.
+*
+* @module @stdlib/nlp/sentencize
+*
+* @example
+* var sentencize = require( '@stdlib/nlp/sentencize' );
+*
+* var str = 'Hello Mrs. Maple, could you call me back? I need to talk to you about something.';
+* var out = sentencize( str );
+* // returns [ 'Hello Mrs. Maple, could you call me back?', 'I need to talk to you about something.' ]
+*/
+
+// MODULES //
+
+var main = require( './main.js' );
+
+
+// EXPORTS //
+
+module.exports = main;