simple-squiggle

A restricted subset of Squiggle
Log | Files | Refs | README

equalText.md (1164B)

      1 <!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
      2 
      3 # Function equalText
      4 
      5 Check equality of two strings. Comparison is case sensitive.
      6 
      7 For matrices, the function is evaluated element wise.
      8 
      9 
     10 ## Syntax
     11 
     12 ```js
     13 math.equalText(x, y)
     14 ```
     15 
     16 ### Parameters
     17 
     18 Parameter | Type | Description
     19 --------- | ---- | -----------
     20 `x` | string &#124; Array &#124; DenseMatrix | First string to compare
     21 `y` | string &#124; Array &#124; DenseMatrix | Second string to compare
     22 
     23 ### Returns
     24 
     25 Type | Description
     26 ---- | -----------
     27 number &#124; Array &#124; DenseMatrix | Returns true if the values are equal, and false if not.
     28 
     29 
     30 ### Throws
     31 
     32 Type | Description
     33 ---- | -----------
     34 
     35 
     36 ## Examples
     37 
     38 ```js
     39 math.equalText('Hello', 'Hello')     // returns true
     40 math.equalText('a', 'A')             // returns false
     41 math.equal('2e3', '2000')            // returns true
     42 math.equalText('2e3', '2000')        // returns false
     43 
     44 math.equalText('B', ['A', 'B', 'C']) // returns [false, true, false]
     45 ```
     46 
     47 
     48 ## See also
     49 
     50 [equal](equal.md),
     51 [compareText](compareText.md),
     52 [compare](compare.md),
     53 [compareNatural](compareNatural.md)