Raze

From APL Wiki
Revision as of 20:45, 8 February 2021 by Marshall (talk | contribs) (Fix syntax highlighting error)
Jump to navigation Jump to search
The Right Shoe symbol is more commonly used for First or Mix.

Raze (), ; in J, or Join () in BQN, is a monadic function which combines element arrays of a nested vector along the first axis (in accordance with leading axis theory). Thus, the major cells of the Raze of an array are the major cells of its element arrays: unlike Mix, which removes a level of depth while keeping outer and inner axes separate, Raze merges the outer vector's axis with the first axis of each element. Raze is present in A+, J, and BQN.

Examples

Raze can turn a vector of vectors into a single vector. Unlike Mix, it inserts no fill elements.

      ⊃(2 3 4;0 1;5)
2 3 4 0 1 5
Works in: A+

When elements of the argument have rank more than 1, Raze combines them along the leading axis, like Catenate First. In A+, the elements must have the same rank and major cell shape or an error results; in J, lower-rank arrays are promoted to a higher rank and arrays are padded with fills to a common major cell shape.

      ⊃(⍳2 2;-⍳4 2)
 0  1
 2  3
 0 ¯1
¯2 ¯3
¯4 ¯5
¯6 ¯7
Works in: A+

Properties

Raze is similar to the Catenate reduction ↑⍪/. If X is a vector whose elements have equal and positive rank, then ↑⍪/X is the Raze of X. The definition differs if X is a singleton vector with scalar elements, because the Raze of X will be a vector while the reduction implementation results in a scalar (or, in NARS2000, a DOMAIN ERROR). This is because Raze treats scalar elements of its argument as singleton vectors, a convention which may be viewed as scalar rank extension or as a result of the idea that a scalar's only major cell is itself.

Raze is the inverse of Partition and Partitioned Enclose on vectors: partitioning, then razing, a vector gives that vector back. It is also an inverse to partition functions which partition major cells along the first axis, although few partition functions do this.

High-rank extension

Raze can be extended to an argument array of rank greater than 1, allowing it to merge block matrices or higher-dimensional structures. This extension is part of BQN, but has not been implemented in any APL, and would not be backwards-compatible in J, since J's Raze implicitly ravels its argument.

The axes of a high-rank argument should be paired with those of its element arrays, starting at the first axis (much like prefix agreement). The elements can be merged without adding fills when the length of an element along a particular axis depends only on its position along that axis in the outer array. That is, in ⊃X, ⍴¨X must match ⊃∘.,/S, where S is a vector containing ≢⍴X vectors followed by any number of scalars. In this case, the shape of ⊃X is +/¨S. The result can be computed by performing a modified 1-dimensional Raze several times. The modified Raze should maintain some number of leading inner element axes. With the Rank operator () we might write ⍪⍤(1-≢⍴X)/X for a single step in the process, thus reducing along the last axis and catenating along the same axis.

If the element arrays of X do not satisfy the shape requirements, they could be padded with fills to force this requirement to hold.

External links

Documentation

APL built-ins [edit]
Primitives (Timeline) Functions
Scalar
Monadic ConjugateNegateSignumReciprocalMagnitudeExponentialNatural LogarithmFloorCeilingFactorialNotPi TimesRollTypeImaginarySquare RootRound
Dyadic AddSubtractTimesDivideResiduePowerLogarithmMinimumMaximumBinomialComparison functionsBoolean functions (And, Or, Nand, Nor) ∙ GCDLCMCircularComplexRoot
Non-Scalar
Structural ShapeReshapeTallyDepthRavelEnlistTableCatenateReverseRotateTransposeRazeMixSplitEncloseNestCut (K)PairLinkPartitioned EnclosePartition
Selection FirstPickTakeDropUniqueIdentityStopSelectReplicateExpandSet functions (IntersectionUnionWithout) ∙ Bracket indexingIndexCartesian ProductSort
Selector Index generatorGradeIndex OfInterval IndexIndicesDealPrefix and suffix vectors
Computational MatchNot MatchMembershipFindNub SieveEncodeDecodeMatrix InverseMatrix DivideFormatExecuteMaterialiseRange
Operators Monadic EachCommuteConstantReplicateExpandReduceWindowed ReduceScanOuter ProductKeyI-BeamSpawnFunction axisIdentity (Null, Ident)
Dyadic BindCompositions (Compose, Reverse Compose, Beside, Withe, Atop, Over) ∙ Inner ProductDeterminantPowerAtUnderRankDepthVariantStencilCutDirect definition (operator)Identity (Lev, Dex)
Quad names Index originComparison toleranceMigration levelAtomic vector