comparisons.r: Function and Context Index

syntax: =b <str-val> Return empty block if unset value found

Function: =n

syntax: =n <str-val> Return none if unset value found

Function: =s

syntax: =s <str-val> Return empty string if unset value found

Function: ???

syntax: ??? <any-type> Prints information about words and values. Handles multiple docstrings.

Function: abort

syntax: abort <block-str-msg> Abort process and shut down

Function: aligned?

    syntax: aligned? <series-or-int> <divisor>
    description: test to see if an integer or the length of a series
    is evenly divisible by a whole number.

Function: all-lowercase

syntax: all-lowercase <string> Return true if string is all lower case

Function: all-uppercase

syntax: all-uppercase <string> Return true if string is all upper case

Function: between

syntax: between <low-number> <val-number> <high-number>
Description: Is val between low and high?

Function: data?

syntax: data? v Tests data in a series value. Returns false for empty series.

Function: dbg

    syntax: dbg <any-type> Debugs a word, includes spelling. If an object,
    checks for a _data_ member and displays it.
    example:: a: 4 || dbg a => "a: 4"

Function: err-handler

syntax: err-handler <error> Machine - sensitive error handler

Function: err-report

syntax: err-report <err> simple error formating interface

Function: error-string

    syntax: error-string <error-object> Compose a string representation of error object.
    note: If you do not fully understand the magic of setting arg2 and arg3
      it would be useful to probe system/error. The 3 arguments are used
      to extract a human-readable message from the system/error object

Function: export

syntax: export <block-of-words> Export local words in the global context.
refinement: /to Export to this object instead of SYSTEM/WORDS

Function: fetch

    syntax: fetch <any-type>
    Description: safe data retrieval. Handles any value.
    Refinements: with /seed, argument is the default value
    /deep - if block, reduce
    /same - if unset, return arg
    /default <any-default-value> - If evaluates to false return default value.

Function: form-error

    syntax: form-error <error-object> <markup-block>
    description: Compose a message representation of an error object.
    args: markup Use to make more readable. markup 1 & 4 wrap the message.
      markup 2 & 3 for near and where attributes respectively.
    Note: All four elements of markup are optional
    Note: Send email of error
    refinement: /user add footnote

Function: global?

syntax: global? <word> Is word global?

Function: has-data?

syntax: has-data? <any-type>
return: False if empty series, string with only whitespace, none or false

Function: int-block

syntax: int-block <block> Return true if all members are integers

Function: int-string?

syntax: int-string? <str-str>
Return: Integer representation of string, or false

Function: invalid-argument

syntax: invalid-argument <arg> Throw an "Invalid argument" error.

Function: is-decimal

syntax: is-decimal <str-str> <int-degrees-of-precision>
description: Test if string is decimal and correct decimal places.

Function: is-email?

syntax: is-email? <string> Is string a legitimate email address?

Function: is-integer

syntax: is-integer <str-str>
description: Test if value can be converted to an integer

Function: is-whitespace

syntax: is-whitespace <char>

Function: len-eq

syntax: len-eq <str-where> <s1-series> <s2-series>
Description: Raise an exception if S1 and S2 are not equal in length.

Function: longest

syntax: longest <block> Returns length of longest member of a series
Note:: Non-series members are ignored

Function: many?

syntax: many? <number> True if number is greater than 1

Function: mrk

syntax: mrk refinement <str-msg> Simple but effective debugging for CGI.

Function: mrks

syntax: mrks <str-s> Simple but effective debugging for CGI.

Function: mysql-legal

    syntax: mysql-legal <str-str>
    description: Convert a string to a legal mysql identifier.
    refinement: (upper) Words are capitalized, else join words with underscores
    refinement: (nodefault) Don't return the default value

Function: no-data?

syntax: no-data? v Returns true of v has no data.

Function: not-found?

syntax: not-found? <val> Is val equal to the not-found constant?

Function: not-whitespace

syntax: not-whitespace <char>

Function: one?

syntax: one? <number> True if number is equal to 1

Function: pass

syntax: pass Do nothing. Handy for readability.

Function: pos?

syntax: pos? <series-target> <any-type-v>
description: Return index of location if found or none

Function: print-error

    syntax: print-error <obj-error>
    Description: Print out a disarmed and formatted error message.
    Example:
    except: either WorkStation[[print-error/simple disarm err ]][[err-handler err]]
    if error? set/any (quote err) try application except (remember to quote err)
    Refinement: /at location extra information
    Refinement: /only Treat as if console application
    Refinement: /simple Don't format for HTML

Function: raise

syntax: raise <str-block-message> User-raised error
Refinement: (/at) Location, or anything extra

Function: safe-reduce

syntax: safe-reduce <block> Reduce block, leaving unset values
refinement: /deep - Reduce nested blocks

Function: setd

syntax: setd <any-d> <any-default>
Description: check for unset values and return default if found.

Function: setq

    syntax: setq <word> <any-type>
    description: Reset an existing word with a value to a new value.
    Best used with globals inside of a def block. No tick is needed.

Function: shortest

syntax: shortest <block> Returns shortest length of members of a block.

Function: simple-error

    syntax: simple-error <str-blk-msg> Provide error message and quit
    refinement: /continue Don't quit /with <color-block> - custom fg and bg colors
    refinement: /finish - shut down specific resources

Function: toss

syntax: toss <str-block-msg> Compose and throw a user error.

Function: uppercase?

syntax: uppercase? <string> Is string all upper case?

Function: wholenumber

syntax: wholenumber <str-or-int-val> Does val translate to a whole number

Function: within