Equal to: Difference between revisions

From APL Wiki
Jump to navigation Jump to search
m (Text replacement - "{{APL built-ins}}" to "{{APL built-ins}}Category:Primitive functions")
 
(8 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Built-in|Equal to|<nowiki>=</nowiki>}} is a [[comparison function]] which tests whether argument elements are [[Tolerant comparison|tolerantly]] equal to each other: it returns 1 if the [[element]]s being compared [[match]] and 0 if they do not. It is the [[Not|negation]] of [[Not Equal to]] (<source lang=apl inline>≠</source>).
{{Built-in|Equal to|<nowiki>=</nowiki>}} is a [[comparison function]] which tests whether argument elements are tolerantly<ref>[[Robert Bernecky|Bernecky, Robert]]. [https://www.jsoftware.com/papers/satn23.htm "Comparison Tolerance"]. Sharp APL Technical Notes. 1977-06-10;.</ref> equal to each other: it returns 1 if the [[element]]s being compared [[match]] and 0 if they do not. It is the [[Not|negation]] of [[Not Equal to]] (<syntaxhighlight lang=apl inline>≠</syntaxhighlight>).


APL's <source lang=apl inline>=</source> differs from the usage of <math>=</math> in [[Comparison with traditional mathematics|traditional mathematical notation]] by having an implied [[Ken_Iverson#Iverson_bracket|Iverson bracket]]. Thus, <source lang=apl inline>i=j</source> is APL is equivalent to <math>[i=j]</math> or <math>\delta_{ij}</math> ([[wikipedia:Kronecker delta|Kronecker delta]]) in mathematics.
APL's <syntaxhighlight lang=apl inline>=</syntaxhighlight> differs from the usage of <math>=</math> in [[Comparison with traditional mathematics|traditional mathematical notation]] by having an implied [[Ken_Iverson#Iverson_bracket|Iverson bracket]]. Thus, <syntaxhighlight lang=apl inline>i=j</syntaxhighlight> is APL is equivalent to <math>[i=j]</math> or <math>\delta_{ij}</math> ([[wikipedia:Kronecker delta|Kronecker delta]]) in mathematics.


== Examples ==
== Examples ==


Equal to compares arrays one [[element]] at a time, returning 1 when elements match and 0 when they do not.
Equal to compares arrays one [[element]] at a time, returning 1 when elements match and 0 when they do not.
<source lang=apl>
<syntaxhighlight lang=apl>
       3 2 1 = 1 2 3
       3 2 1 = 1 2 3
0 1 0
0 1 0
Line 13: Line 13:
       3j2 2j2 1j2 = 2j2
       3j2 2j2 1j2 = 2j2
0 1 0
0 1 0
</source>
</syntaxhighlight>
It is subject to [[comparison tolerance]]: floating-point numbers which are very close together are considered equal, even though they are slightly different:
It is subject to [[comparison tolerance]]: floating-point numbers which are very close together are considered equal, even though they are slightly different:
<source lang=apl>
<syntaxhighlight lang=apl>
       ⎕CT
       ⎕CT
1E¯14
1E¯14
Line 25: Line 25:
       1 {⎕CT←0⋄⍺=⍵} x                  ⍝ Overriding ⎕CT within a dfn
       1 {⎕CT←0⋄⍺=⍵} x                  ⍝ Overriding ⎕CT within a dfn
0 0 1 0 0
0 0 1 0 0
</source>
</syntaxhighlight>
In a [[Nested array model|nested]] APL, Equal to is pervasive, and compares all [[simple scalar]]s found in a [[nested array]].
In a [[Nested array model|nested]] APL, Equal to is pervasive, and compares all [[simple scalar]]s found in a [[nested array]].
<source lang=apl>
<syntaxhighlight lang=apl>
       ⊢n ← ((2 1)0)(1 0 3)(2 2⍴4 0)
       ⎕←n ← ((2 1)0)(1 0 3)(2 2⍴4 0)
┌───────┬─────┬───┐
┌───────┬─────┬───┐
│┌───┬─┐│1 0 3│4 0│
│┌───┬─┐│1 0 3│4 0│
Line 40: Line 40:
│└───┴─┘│    │  │
│└───┴─┘│    │  │
└───────┴─────┴───┘
└───────┴─────┴───┘
</source>
</syntaxhighlight>
In a [[Flat array model|flat]] array language such as [[J]], it instead compares [[Box]]es directly, since they are the [[element]]s of a boxed array.
In a [[Flat array model|flat]] array language such as [[J]], it instead compares [[Box]]es directly, since they are the [[element]]s of a boxed array.
<source lang=j>
<syntaxhighlight lang=j>
   (<'string') = 'which';'is';'string';'?'
   (<'string') = 'which';'is';'string';'?'
0 0 1 0
0 0 1 0
</source>
</syntaxhighlight>


== Boolean function ==
== Boolean function ==
Line 51: Line 51:
When the arguments to Equal to are [[Boolean]], it is the [[wikipedia:Logical biconditional|Logical biconditional]] function, or the [[Not|negation]] of the [[xor]] function (which is [[Not Equal to]] restricted to Boolean arguments):
When the arguments to Equal to are [[Boolean]], it is the [[wikipedia:Logical biconditional|Logical biconditional]] function, or the [[Not|negation]] of the [[xor]] function (which is [[Not Equal to]] restricted to Boolean arguments):
{|class=wikitable
{|class=wikitable
!<source lang=apl inline>=</source>!!<source lang=apl inline>0</source>!!<source lang=apl inline>1</source>
!<syntaxhighlight lang=apl inline>=</syntaxhighlight>!!<syntaxhighlight lang=apl inline>0</syntaxhighlight>!!<syntaxhighlight lang=apl inline>1</syntaxhighlight>
|-
|-
!<source lang=apl inline>0</source>
!<syntaxhighlight lang=apl inline>0</syntaxhighlight>
|<source lang=apl inline>1</source>||<source lang=apl inline>0</source>
|<syntaxhighlight lang=apl inline>1</syntaxhighlight>||<syntaxhighlight lang=apl inline>0</syntaxhighlight>
|-
|-
!<source lang=apl inline>1</source>
!<syntaxhighlight lang=apl inline>1</syntaxhighlight>
|<source lang=apl inline>0</source>||<source lang=apl inline>1</source>
|<syntaxhighlight lang=apl inline>0</syntaxhighlight>||<syntaxhighlight lang=apl inline>1</syntaxhighlight>
|}
|}
In the context of logic, it can be read as ''if and only if''. This function is also known as xnor or the Kronecker delta.
In the context of logic, it can be read as ''if and only if''. This function is also known as xnor or the Kronecker delta.


[[Reduction]] with <source lang=apl inline>=</source> is the same as reduction with xor (<source lang=apl inline>≠</source>), but [[Not|inverted]] if the number of reduced elements is even. The left and right [[identity element]] for Boolean <source lang=apl inline>=</source> is 1.
[[Reduction]] with <syntaxhighlight lang=apl inline>=</syntaxhighlight> is the same as reduction with xor (<syntaxhighlight lang=apl inline>≠</syntaxhighlight>), but [[Not|inverted]] if the number of reduced elements is even. The left and right [[identity element]] for Boolean <syntaxhighlight lang=apl inline>=</syntaxhighlight> is 1.


== External links ==
== External links ==


=== Documentation ===
=== Documentation ===


* [http://help.dyalog.com/latest/index.htm#Language/Primitive%20Functions/Equal.htm Dyalog]
* [https://help.dyalog.com/latest/index.htm#Language/Primitive%20Functions/Equal.htm Dyalog]
* [http://microapl.com/apl_help/ch_020_020_310.htm APLX]
* [http://microapl.com/apl_help/ch_020_020_310.htm APLX]
* J [https://www.jsoftware.com/help/dictionary/d000.htm Dictionary], [https://code.jsoftware.com/wiki/Vocabulary/eq#dyadic NuVoc]
* J [https://www.jsoftware.com/help/dictionary/d000.htm Dictionary], [https://code.jsoftware.com/wiki/Vocabulary/eq#dyadic NuVoc]
{{APL built-ins}}[[Category:Primitive functions]]
* [https://mlochbaum.github.io/BQN/doc/arithmetic.html#comparisons BQN]
== References ==
<references />
{{APL built-ins}}[[Category:Primitive functions]][[Category:Comparison functions]]

Latest revision as of 21:57, 28 November 2022

=

Equal to (=) is a comparison function which tests whether argument elements are tolerantly[1] equal to each other: it returns 1 if the elements being compared match and 0 if they do not. It is the negation of Not Equal to (≠).

APL's = differs from the usage of in traditional mathematical notation by having an implied Iverson bracket. Thus, i=j is APL is equivalent to or (Kronecker delta) in mathematics.

Examples

Equal to compares arrays one element at a time, returning 1 when elements match and 0 when they do not. 

      3 2 1 = 1 2 3
0 1 0
      '321' = '123'
0 1 0
      3j2 2j2 1j2 = 2j2
0 1 0

It is subject to comparison tolerance: floating-point numbers which are very close together are considered equal, even though they are slightly different: 

      ⎕CT
1E¯14
      x ← 1 + (⎕CT×0.6)ׯ2 ¯1 0 1 2     ⍝ Numbers close to 1
      1 - x                             ⍝ Nonzero difference
1.199040867E¯14 5.995204333E¯15 0 ¯5.995204333E¯15 ¯1.199040867E¯14
      1 = x                             ⍝ Close but different values are equal
0 1 1 1 0
      1 {⎕CT←0⋄⍺=⍵} x                   ⍝ Overriding ⎕CT within a dfn
0 0 1 0 0

In a nested APL, Equal to is pervasive, and compares all simple scalars found in a nested array. 

      ⎕←n ← ((2 1)0)(1 0 3)(2 2⍴4 0)
┌───────┬─────┬───┐
│┌───┬─┐│1 0 3│4 0│
││2 1│0││     │4 0│
│└───┴─┘│     │   │
└───────┴─────┴───┘
      0 = n
┌───────┬─────┬───┐
│┌───┬─┐│0 1 0│0 1│
││0 0│1││     │0 1│
│└───┴─┘│     │   │
└───────┴─────┴───┘

In a flat array language such as J, it instead compares Boxes directly, since they are the elements of a boxed array. 

   (<'string') = 'which';'is';'string';'?'
0 0 1 0

Boolean function

Main article: Boolean function

When the arguments to Equal to are Boolean, it is the Logical biconditional function, or the negation of the xor function (which is Not Equal to restricted to Boolean arguments):

= 0 1
0 1 0
1 0 1

In the context of logic, it can be read as if and only if. This function is also known as xnor or the Kronecker delta.

Reduction with = is the same as reduction with xor (≠), but inverted if the number of reduced elements is even. The left and right identity element for Boolean = is 1.

External links

Documentation

References

  1. ↑ Bernecky, Robert. "Comparison Tolerance". Sharp APL Technical Notes. 1977-06-10;.
APL built-ins [edit]
Primitives (Timeline) Functions
Scalar
Monadic Conjugate ∙ Negate ∙ Signum ∙ Reciprocal ∙ Magnitude ∙ Exponential ∙ Natural Logarithm ∙ Floor ∙ Ceiling ∙ Factorial ∙ Not ∙ Pi Times ∙ Roll ∙ Type ∙ Imaginary ∙ Square Root ∙ Round
Dyadic Add ∙ Subtract ∙ Times ∙ Divide ∙ Residue ∙ Power ∙ Logarithm ∙ Minimum ∙ Maximum ∙ Binomial ∙ Comparison functions ∙ Boolean functions (And, Or, Nand, Nor) ∙ GCD ∙ LCM ∙ Circular ∙ Complex ∙ Root
Non-Scalar
Structural Shape ∙ Reshape ∙ Tally ∙ Depth ∙ Ravel ∙ Enlist ∙ Table ∙ Catenate ∙ Reverse ∙ Rotate ∙ Transpose ∙ Raze ∙ Mix ∙ Split ∙ Enclose ∙ Nest ∙ Cut (K) ∙ Pair ∙ Link ∙ Partitioned Enclose ∙ Partition
Selection First ∙ Pick ∙ Take ∙ Drop ∙ Unique ∙ Identity ∙ Stop ∙ Select ∙ Replicate ∙ Expand ∙ Set functions (Intersection ∙ Union ∙ Without) ∙ Bracket indexing ∙ Index ∙ Cartesian Product ∙ Sort
Selector Index generator ∙ Grade ∙ Index Of ∙ Interval Index ∙ Indices ∙ Deal ∙ Prefix and suffix vectors
Computational Match ∙ Not Match ∙ Membership ∙ Find ∙ Nub Sieve ∙ Encode ∙ Decode ∙ Matrix Inverse ∙ Matrix Divide ∙ Format ∙ Execute ∙ Materialise ∙ Range
Operators Monadic Each ∙ Commute ∙ Constant ∙ Replicate ∙ Expand ∙ Reduce ∙ Windowed Reduce ∙ Scan ∙ Outer Product ∙ Key ∙ I-Beam ∙ Spawn ∙ Function axis ∙ Identity (Null, Ident)
Dyadic Bind ∙ Compositions (Compose, Reverse Compose, Beside, Withe, Atop, Over) ∙ Inner Product ∙ Determinant ∙ Power ∙ At ∙ Under ∙ Rank ∙ Depth ∙ Variant ∙ Stencil ∙ Cut ∙ Direct definition (operator) ∙ Identity (Lev, Dex)
Quad names Index origin ∙ Comparison tolerance ∙ Migration level ∙ Atomic vector
Retrieved from ‘https://aplwiki.com/index.php?title=Equal_to&oldid=9947’