iridium - v0.9a
    Preparing search index...

    Class StackRetainSEXP

    Retain N values on the theoretical stack obtained after evaluation of the given Node. Also can take a value for M (nip), which specify how many values below the top retained values need to be removed.

    N = 2, M = 0
    INITIAL : a b <- top
    FINAL   : a b

    N = 2, M = 1
    INITIAL : a b c <- top
    FINAL   : b c

    • ...ARG(Node): Node(s) to be evaluated (one or more).

    • FLAG(NVAL): Number of VALUES pushed onto the stack.

    • FLAG(NIP): Remove values that occur after the first NVAL.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    args flags tag

    Methods

    getFlag getFlagBoolean getFlagNumber getFlagString getNip getNode getNVal hasFlag removeFlag serialize setFlag setNip setNode setNVal toString

    Constructors

    Properties

    args: IridiumSEXP[] = []

    Args are the children nodes to the current node.

    flags: [string, IridiumPrimitives][] = []

    Flags store metadata/primitive data in an Iridium node. These nodes cannot store other Iridium S-Expressions.

    tag: string = "IridiumSEXP"

    Tag specifics the S-Expression Type.

    Methods

    • Parameters

      • flag: string

      Returns boolean

    • Parameters

      • flag: string

      Returns number

    • Parameters

      • flag: string

      Returns string

    • Returns number

    • Returns number

    • Parameters

      • flag: string

      Returns boolean

    • Parameters

      • flag: string

      Returns void

    • This method is used to squish the Iridium Code into an array which can be easily stored on disk.

      Returns any[]

      Nested Array of Iridium S-Expressions.

    • Parameters

      • nip: number

      Returns void

    • Parameters

      • nVal: number

      Returns void

    • Parameters

      • space: number = 0

      Returns string

    Settings

    Member Visibility

    On This Page

    Structure
    Constructors
    Properties
    Methods