System Labels

Normally, execution of a user-defined function/operator starts execution at line one. However, in certain contexts, execution may start at a different line depending upon the context and the presence of a System Label. These special labels start with a quad symbol so as to present no confusion with normal labels. The following table lists the system labels defined so far and the special context in which they are used.

⎕PROTOTYPE: is called where a prototype element is needed as in foo¨R where R is empty. ⎕IDENTITY: is called where an identity element is needed as in foo/R where R is empty.

For example,

    ∇ Z←L foo R
[1]   Z←L,R ⋄ →0
[2]   ⎕PROTOTYPE:Z←'Prototype' ⋄ →0
[3]   ⎕IDENTITY:Z←'Identity'
    ∇

      ⎕fmt foo/⍳0
┌──────────┐
│┌8───────┐│
││Identity││
│└────────┘2
└∊─────────┘
      ⎕fmt 1 foo¨⍬
┌0──────────┐
│┌9────────┐│
││Prototype││
│└─────────┘2
└∊──────────┘

• In the Identity element case, the function is called with the reduction function's right argument prototype as the right argument to the user-defined function/operator; the left argument is undefined. For example, in foo/3 0⍴⊂⍳4, the (right) argument passed to the function is 0 0 0 0. The return value from the function is used as the common item in the result. Thus, the ⎕IDENTITY entry point is called only once even though the result may have multiple copies of the return value.

• In the Prototype case, the user-defined function/operator is called with arguments that are the prototypes of the respective arguments.