The yah Reference Manual

3.1.1 yah/yah.asd

Source

yah.asd.

Parent Component

yah (system).

ASDF Systems

yah.

3.1.2 yah/package.lisp

Source

yah.asd.

Parent Component

yah (system).

Packages

yah.

Internals

• @yah (special variable).
• write-readme (function).

3.1.3 yah/yah.lisp

Dependency

package.lisp (file).

Source

yah.asd.

Parent Component

yah (system).

Public Interface

• change-key! (function).
• delete! (function).
• empty-heap? (function).
• extract! (function).
• extract-insert! (function).
• finger (class).
• heap (class).
• insert! (function).
• insert-extract! (function).
• make-heap (function).
• peek (function).

Internals

• content<- (reader method).
• heap-down! (function).
• heap-up! (function).
• index<- (reader method).
• (setf index<-) (writer method).
• key<- (reader method).
• (setf key<-) (writer method).
• predicate<- (reader method).
• value<- (reader method).
• (setf value<-) (writer method).

5.1.1 Ordinary functions

Function: change-key! (heap finger key) ¶

Changes the key of ‘FINGER‘ in ‘HEAP‘ to ‘KEY‘.

Package

yah.

Source

yah.lisp.

Function: delete! (heap finger) ¶

Remove ‘FINGER‘ from ‘HEAP‘.

Package

yah.

Source

yah.lisp.

Function: empty-heap? (heap) ¶

Returns ‘T‘ if ‘HEAP‘ is empty, and ‘NIL‘ otherwise.

Package

yah.

Source

yah.lisp.

Function: extract! (heap) ¶

Pop the top element from the ‘HEAP‘, according to the heap’s
predicate. Returns two values: The value and the key of the popped element.

Fails if ‘HEAP‘ is empty.

Package

yah.

Source

yah.lisp.

Function: extract-insert! (heap key value) ¶

First pop the top element of ‘HEAP‘, then insert ‘VALUE‘ at ‘KEY‘. Returns two values: The value and the key of the popped element.

Fails if ‘HEAP‘ is empty.

Package

yah.

Source

yah.lisp.

Function: insert! (heap key value) ¶

Add ‘VALUE‘ with at ‘KEY‘ into the ‘HEAP‘. Returns a finger to the resulting entry in the heap.

Package

yah.

Source

yah.lisp.

Function: insert-extract! (heap key value) ¶

Insert ‘VALUE‘ at ‘KEY‘ into ‘HEAP‘, then immediately pop the top element.

Package

yah.

Source

yah.lisp.

Function: make-heap (predicate) ¶

Makes a heap sorting by predicate ‘PREDICATE‘. This means that if there are two values with keys A and B on the heap, if ‘(funcall predicate a b)‘ is true, A will be popped off the heap before B.

Package

yah.

Source

yah.lisp.

Function: peek (heap) ¶

Returns two values: The value and the key of the top element of the ‘HEAP‘.

Package

yah.

Source

yah.lisp.

5.1.2 Classes

Class: finger ¶

Package

yah.

Source

yah.lisp.

Direct methods

• (setf index<-).
• index<-.
• (setf key<-).
• key<-.
• (setf value<-).
• value<-.

Direct slots

Slot: %key ¶

Initargs

:key

Readers

key<-.

Writers

(setf key<-).

Slot: %value ¶

Initargs

:value

Readers

value<-.

Writers

(setf value<-).

Slot: %index ¶

Initargs

:index

Readers

index<-.

Writers

(setf index<-).

Class: heap ¶

Package

yah.

Source

yah.lisp.

Direct methods

• content<-.
• predicate<-.

Direct slots

Slot: %content ¶

Type

(array yah:finger 1)

Initform

(make-array 0 :element-type (quote yah:finger) :adjustable t :fill-pointer t)

Readers

content<-.

Writers

This slot is read-only.

Slot: %predicate ¶

Type

function

Initargs

:predicate

Readers

predicate<-.

Writers

This slot is read-only.

5.2.1 Special variables

Special Variable: @yah ¶

Package

yah.

Source

package.lisp.

5.2.2 Ordinary functions

Function: heap-down! (heap i) ¶

Package

yah.

Source

yah.lisp.

Function: heap-up! (heap i) ¶

Package

yah.

Source

yah.lisp.

Function: write-readme (&optional file) ¶

Package

yah.

Source

package.lisp.

5.2.3 Generic functions

Generic Reader: content<- (object) ¶

Package

yah.

Methods

Reader Method: content<- ((heap heap)) ¶

automatically generated reader method

Source

yah.lisp.

Target Slot

%content.

Generic Reader: index<- (object) ¶

Package

yah.

Methods

Reader Method: index<- ((finger finger)) ¶

automatically generated reader method

Source

yah.lisp.

Target Slot

%index.

Generic Writer: (setf index<-) (object) ¶

Package

yah.

Methods

Writer Method: (setf index<-) ((finger finger)) ¶

automatically generated writer method

Source

yah.lisp.

Target Slot

%index.

Generic Reader: key<- (object) ¶

Package

yah.

Methods

Reader Method: key<- ((finger finger)) ¶

automatically generated reader method

Source

yah.lisp.

Target Slot

%key.

Generic Writer: (setf key<-) (object) ¶

Package

yah.

Methods

Writer Method: (setf key<-) ((finger finger)) ¶

automatically generated writer method

Source

yah.lisp.

Target Slot

%key.

Generic Reader: predicate<- (object) ¶

Package

yah.

Methods

Reader Method: predicate<- ((heap heap)) ¶

automatically generated reader method

Source

yah.lisp.

Target Slot

%predicate.

Generic Reader: value<- (object) ¶

Package

yah.

Methods

Reader Method: value<- ((finger finger)) ¶

automatically generated reader method

Source

yah.lisp.

Target Slot

%value.

Generic Writer: (setf value<-) (object) ¶

Package

yah.

Methods

Writer Method: (setf value<-) ((finger finger)) ¶

automatically generated writer method

Source

yah.lisp.

Target Slot

%value.