time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

main.js (1874B)

      1 /**
      2 * @license Apache-2.0
      3 *
      4 * Copyright (c) 2020 The Stdlib Authors.
      5 *
      6 * Licensed under the Apache License, Version 2.0 (the "License");
      7 * you may not use this file except in compliance with the License.
      8 * You may obtain a copy of the License at
      9 *
     10 *    http://www.apache.org/licenses/LICENSE-2.0
     11 *
     12 * Unless required by applicable law or agreed to in writing, software
     13 * distributed under the License is distributed on an "AS IS" BASIS,
     14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     15 * See the License for the specific language governing permissions and
     16 * limitations under the License.
     17 */
     18 
     19 'use strict';
     20 
     21 // MODULES //
     22 
     23 var isString = require( '@stdlib/assert/is-string' ).isPrimitive;
     24 var nextGraphemeClusterBreak = require( './../../next-grapheme-cluster-break' );
     25 var format = require( './../../format' );
     26 
     27 
     28 // MAIN //
     29 
     30 /**
     31 * Returns the number of grapheme clusters in a string.
     32 *
     33 * @param {string} str - input string
     34 * @throws {TypeError} must provide a string
     35 * @returns {NonNegativeInteger} number of grapheme clusters
     36 *
     37 * @example
     38 * var out = numGraphemeClusters( 'last man standing' );
     39 * // returns 17
     40 *
     41 * @example
     42 * var out = numGraphemeClusters( 'presidential election' );
     43 * // returns 21
     44 *
     45 * @example
     46 * var out = numGraphemeClusters( 'अनुच्छेद' );
     47 * // returns 5
     48 *
     49 * @example
     50 * var out = numGraphemeClusters( '🌷' );
     51 * // returns 1
     52 */
     53 function numGraphemeClusters( str ) {
     54 	var count;
     55 	var idx;
     56 	var brk;
     57 
     58 	if ( !isString( str ) ) {
     59 		throw new TypeError( format( 'invalid argument. Must provide a string. Value: `%s`.', str ) );
     60 	}
     61 	count = 0;
     62 	idx = 0;
     63 
     64 	brk = nextGraphemeClusterBreak( str, idx );
     65 	while ( brk !== -1 ) {
     66 		count += 1;
     67 		idx = brk;
     68 		brk = nextGraphemeClusterBreak( str, idx );
     69 	}
     70 	if ( idx < str.length ) {
     71 		count += 1;
     72 	}
     73 	return count;
     74 }
     75 
     76 
     77 // EXPORTS //
     78 
     79 module.exports = numGraphemeClusters;