Class SKI

Hierarchy (View Summary)

Parser
- SKI

Index

Constructors

constructor

new SKI(options?: ParserOptions): SKI
Parameters
- options: ParserOptions = {}
Returns SKI
Inherited from Parser.constructor
- Defined in parser.ts:114

Properties

addContext

addContext: boolean

Param: options

allow

allow: Set<string>

annotate

annotate: boolean

hasLambdas

hasLambdas: boolean

hasNumbers

hasNumbers: boolean

known

known: Record<string, Named>

`Static`B

B: Native = native.B

`Static`C

C: Native = native.C

`Static`classes

classes: {
    Alias: typeof Alias;
    App: typeof App;
    Church: typeof Church;
    Expr: typeof Expr;
    FreeVar: typeof FreeVar;
    Lambda: typeof Lambda;
    Named: typeof Named;
    Native: typeof Native;
} = classes

`Static`control

control: {
    descend: <T>(value?: T) => TraverseControl<T>;
    prune: <T>(value?: T) => TraverseControl<T>;
    redo: <T>(value?: T) => TraverseControl<T>;
    stop: <T>(value?: T) => TraverseControl<T>;
} = control

`Static`extras

extras: {
    checkFormatOptions: (
        raw: unknown,
    ) => { value: FormatOptions } | { error: Record<string, string> };
    declare: (expr: Expr, env?: Record<string, Named>) => string;
    deepFormat: (obj: any, options?: FormatOptions) => any;
    equiv: (e1: Expr, e2: Expr, options?: {}) => EquivResult;
    search: (
        seed: Expr[],
        options: SearchOptions,
        predicate: SearchCallback,
    ) => SearchResult;
    toposort: (
        options: {
            allow?: Record<string, Named>;
            env?: Record<string, Named>;
            list?: Expr | Expr[];
        },
    ) => ToposortResult;
} = extras

Type Declaration

checkFormatOptions: (raw: unknown) => { value: FormatOptions } | { error: Record<string, string> }
declare: (expr: Expr, env?: Record<string, Named>) => string
deepFormat: (obj: any, options?: FormatOptions) => any
equiv: (e1: Expr, e2: Expr, options?: {}) => EquivResult
search: (
    seed: Expr[],
    options: SearchOptions,
    predicate: SearchCallback,
) => SearchResult
toposort: (
    options: {
        allow?: Record<string, Named>;
        env?: Record<string, Named>;
        list?: Expr | Expr[];
    },
) => ToposortResult

`Static`I

I: Native = native.I

`Static`K

K: Native = native.K

`Static`native

native: Record<string, Native> = native

`Static`Quest

Quest: typeof Quest = Quest

`Static`S

S: Native = native.S

`Static`W

W: Native = native.W

Methods

add

add(
    term: string | Alias,
    impl?: string | Expr | ((arg: Expr) => Invocation),
    options?: string | AddOptions,
): this
Declare a new term If the first argument is an Alias, it is added as is. Otherwise, a new Alias or Native term (depending on impl type) is created. If note is not provided and this.annotate is true, an automatic note is generated.

If impl is a function, it should have signature (Expr) => ... => Expr (see typedef Partial at top of expr.js)
Parameters
- term: string | Alias
- Optionalimpl: string | Expr | ((arg: Expr) => Invocation)
- Optionaloptions: string | AddOptions
  - string
  - AddOptions
    Optionalarity?: number
    Optionalcanonize?: boolean
    Optionalfancy?: string
    Optionalnote?: string
Returns this
chainable
Example
```
ski.add('T', 'S(K(SI))K', 'swap combinator')
```
Example
```
ski.add( ski.parse('T = S(K(SI))K') ) // ditto but one-arg form
```
Example
```
ski.add('T', x => y => y.apply(x), 'swap combinator') // heavy artillery
```
Example
```
ski.add('Y', function (f) { return f.apply(this.apply(f)); }, 'Y combinator')
```
Inherited from Parser.add
- Defined in parser.ts:165

bulkAdd

bulkAdd(list: string[]): this
Declare and remove multiple terms at once term=impl adds term term= removes term
Parameters
- list: string[]
Returns this
chainable
Inherited from Parser.bulkAdd
- Defined in parser.ts:231

declare

declare(): string[]
Export term declarations for use in bulkAdd(). Currently only Alias terms are serialized.

Returns string[]
Inherited from Parser.declare
- Defined in parser.ts:311

getTerms

getTerms(): Record<string, Named>
Returns Record<string, Named>
Inherited from Parser.getTerms
- Defined in parser.ts:297

maybeAdd

maybeAdd(name: string, impl: string | Expr | ((arg: Expr) => Invocation)): this
Experimental
Declare a new term if it is not known, otherwise just allow it. Currently only used by quests. Use with caution, this function may change its signature, behavior, or even be removed in the future.
Parameters
- name: string
- impl: string | Expr | ((arg: Expr) => Invocation)
Returns this
Inherited from Parser.maybeAdd
- Defined in parser.ts:216

parse

parse(source: string, options?: ParseOptions): Expr
Parameters
- source: string
- Optionaloptions: ParseOptions = {}
  - Optionalallow?: string
  - Optionalcanonize?: boolean
  - Optionalenv?: { [key: string]: Expr }
  - Optionallambdas?: boolean
  - Optionalnumbers?: boolean
  - Optionalscope?: object
Returns Expr
Inherited from Parser.parse
- Defined in parser.ts:390

parseLine

parseLine(
    source: string,
    env?: { [key: string]: Expr },
    options?: ParseOptions,
): Expr
Parse a single line of source code, without splitting it into declarations. Internal, always use parse() instead.
Parameters
- source: string
  S(KI)I
- env: { [key: string]: Expr } = {}
- Optionaloptions: ParseOptions = {}
  - Optionalallow?: string
  - Optionalcanonize?: boolean
  - Optionalenv?: { [key: string]: Expr }
  - Optionallambdas?: boolean
  - Optionalnumbers?: boolean
  - Optionalscope?: object
Returns Expr
parsed expression
Inherited from Parser.parseLine
- Defined in parser.ts:452

remove

remove(name: string): this
Parameters
- name: string
Returns this
Inherited from Parser.remove
- Defined in parser.ts:284

restrict

restrict(spec: string): this
Restrict the interpreter to given terms. Terms prepended with '+' will be added and terms preceeded with '-' will be removed.
Parameters
- spec: string
Returns this
chainable
Example
```
ski.restrict('SK') // use the basis
```
Example
```
ski.restrict('+I') // allow I now
```
Example
```
ski.restrict('-SKI +BCKW' ); // switch basis
```
Example
```
ski.restrict('-foo -bar'); // forbid some user functions
```
Inherited from Parser.restrict
- Defined in parser.ts:256

showRestrict

showRestrict(spec?: string): string
Parameters
- spec: string = '+'
Returns string
Inherited from Parser.showRestrict
- Defined in parser.ts:266

toJSON

toJSON(): {
    allow: string;
    annotate: boolean;
    lambdas: boolean;
    numbers: boolean;
    terms: string[];
    version: string;
}
Returns {
    allow: string;
    annotate: boolean;
    lambdas: boolean;
    numbers: boolean;
    terms: string[];
    version: string;
}
Inherited from Parser.toJSON
- Defined in parser.ts:512

`Static`church

church(n: number): Church
Parameters
- n: number
Returns Church
- Defined in index.ts:45

`Static`vars

vars(scope?: object): { [key: string]: FreeVar }
Create a proxy object that generates variables on demand, with names corresponding to the property accessed. Different invocations will return distinct variables, even if with the same name.
Parameters
- scope: object = {}
Returns { [key: string]: FreeVar }
Example
```
const {x, y, z} = SKI.vars();
         x.name; // 'x'
         x instanceof FreeVar; // true
         x.apply(y).apply(z); // x(y)(z)
```
- Defined in index.ts:33

Class SKI

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SKI

Properties

addContext

Param: options

allow

annotate

hasLambdas

hasNumbers

known

StaticB

StaticC

Staticclasses

Staticcontrol

Staticextras

Type Declaration

checkFormatOptions: (raw: unknown) => { value: FormatOptions } | { error: Record<string, string> }

declare: (expr: Expr, env?: Record<string, Named>) => string

deepFormat: (obj: any, options?: FormatOptions) => any

equiv: (e1: Expr, e2: Expr, options?: {}) => EquivResult

search: ( seed: Expr[], options: SearchOptions, predicate: SearchCallback,) => SearchResult

toposort: ( options: { allow?: Record<string, Named>; env?: Record<string, Named>; list?: Expr | Expr[]; },) => ToposortResult

StaticI

StaticK

Staticnative

StaticQuest

StaticS

StaticW

Methods

add

Parameters

Optionalarity?: number

Optionalcanonize?: boolean

Optionalfancy?: string

Optionalnote?: string

Returns this

Example

Example

Example

Example

bulkAdd

Parameters

Returns this

declare

Returns string[]

getTerms

Returns Record<string, Named>

maybeAdd

Parameters

Returns this

parse

Parameters

Optionalallow?: string

Optionalcanonize?: boolean

Optionalenv?: { [key: string]: Expr }

Optionallambdas?: boolean

Optionalnumbers?: boolean

Optionalscope?: object

Returns Expr

parseLine

Parameters

Optionalallow?: string

Optionalcanonize?: boolean

Optionalenv?: { [key: string]: Expr }

Optionallambdas?: boolean

Optionalnumbers?: boolean

Optionalscope?: object

Returns Expr

remove

Parameters

Returns this

restrict

`Static`B

`Static`C

`Static`classes

`Static`control

`Static`extras

search: (
seed: Expr[],
options: SearchOptions,
predicate: SearchCallback,
) => SearchResult

toposort: (
options: {
allow?: Record<string, Named>;
env?: Record<string, Named>;
list?: Expr | Expr[];
},
) => ToposortResult

`Static`I

`Static`K

`Static`native

`Static`Quest

`Static`S

`Static`W

`Optional`arity?: number

`Optional`canonize?: boolean

`Optional`fancy?: string

`Optional`note?: string

`Optional`allow?: string

`Optional`canonize?: boolean

`Optional`env?: { [key: string]: Expr }

`Optional`lambdas?: boolean

`Optional`numbers?: boolean

`Optional`scope?: object

`Optional`allow?: string

`Optional`canonize?: boolean

`Optional`env?: { [key: string]: Expr }

`Optional`lambdas?: boolean

`Optional`numbers?: boolean

`Optional`scope?: object

Returns {
allow: string;
annotate: boolean;
lambdas: boolean;
numbers: boolean;
terms: string[];
version: string;
}

`Static`church

`Static`vars