Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]

The quantile-estimator Reference Manual

This is the quantile-estimator Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 17:40:42 2024 GMT+0.

Next: Systems, Previous: The quantile-estimator Reference Manual, Up: The quantile-estimator Reference Manual [Contents][Index]

1 Introduction

Next: Modules, Previous: Introduction, Up: The quantile-estimator Reference Manual [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.

quantile-estimator

Previous: Systems, Up: Systems [Contents][Index]

2.1 `quantile-estimator`

Implementation of Graham Cormode and S. Muthukrishnan’s
Effective Computation of Biased Quantiles over Data Streams in ICDE’05

Author: Ilya Khaprov <ilya.kharpov@publitechs.com>
License: MIT
Version: 0.0.1
Dependency: alexandria (system).
Source: quantile-estimator.asd.
Child Component: src (module).

Next: Files, Previous: Systems, Up: The quantile-estimator Reference Manual [Contents][Index]

3 Modules

Modules are listed depth-first from the system components tree.

quantile-estimator/src

Previous: Modules, Up: Modules [Contents][Index]

3.1 `quantile-estimator/src`

Source

quantile-estimator.asd.

Parent Component

quantile-estimator (system).

Child Components

package.lisp (file).
quantile.lisp (file).
estimator.lisp (file).

Next: Packages, Previous: Modules, Up: The quantile-estimator Reference Manual [Contents][Index]

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.

Lisp

Previous: Files, Up: Files [Contents][Index]

4.1 Lisp

quantile-estimator/quantile-estimator.asd
quantile-estimator/src/package.lisp
quantile-estimator/src/quantile.lisp
quantile-estimator/src/estimator.lisp

Next: quantile-estimator/src/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

4.1.1 `quantile-estimator/quantile-estimator.asd`

Source: quantile-estimator.asd.
Parent Component: quantile-estimator (system).
ASDF Systems: quantile-estimator.

Next: quantile-estimator/src/quantile.lisp, Previous: quantile-estimator/quantile-estimator.asd, Up: Lisp [Contents][Index]

4.1.2 `quantile-estimator/src/package.lisp`

Source: quantile-estimator.asd.
Parent Component: src (module).
Packages: quantile-estimator.

Next: quantile-estimator/src/estimator.lisp, Previous: quantile-estimator/src/package.lisp, Up: Lisp [Contents][Index]

4.1.3 `quantile-estimator/src/quantile.lisp`

Dependency

package.lisp (file).

Source

quantile-estimator.asd.

Parent Component

src (module).

Public Interface

make-quantile (function).
quantile-inaccuracy (reader method).
quantile-quantile (reader method).
quantile.delta (function).

Internals

quantile (class).

Previous: quantile-estimator/src/quantile.lisp, Up: Lisp [Contents][Index]

4.1.4 `quantile-estimator/src/estimator.lisp`

Dependency

quantile.lisp (file).

Source

quantile-estimator.asd.

Parent Component

src (module).

Public Interface

estimator-invariants (reader method).
estimator-observations (reader method).
(setf estimator-observations) (writer method).
estimator-sum (reader method).
(setf estimator-sum) (writer method).
estimator.observe (function).
estimator.query (function).
make-estimator (function).

Internals

+buffer-size+ (constant).
estimator (class).
estimator.compress (function).
estimator.flush (function).
estimator.invariant (function).
estimator.replace-batch (function).
make-sample (function).
sample (class).
sample-delta (reader method).
(setf sample-delta) (writer method).
sample-rank (reader method).
(setf sample-rank) (writer method).
sample-successor (reader method).
(setf sample-successor) (writer method).
sample-value (reader method).
(setf sample-value) (writer method).

Next: Definitions, Previous: Files, Up: The quantile-estimator Reference Manual [Contents][Index]

5 Packages

Packages are listed by definition order.

quantile-estimator

Previous: Packages, Up: Packages [Contents][Index]

5.1 `quantile-estimator`

Source

package.lisp.

Use List

alexandria.
common-lisp.

Public Interface

estimator-invariants (generic reader).
estimator-observations (generic reader).
(setf estimator-observations) (generic writer).
estimator-sum (generic reader).
(setf estimator-sum) (generic writer).
estimator.observe (function).
estimator.query (function).
make-estimator (function).
make-quantile (function).
quantile-inaccuracy (generic reader).
quantile-quantile (generic reader).
quantile.delta (function).

Internals

+buffer-size+ (constant).
estimator (class).
estimator.compress (function).
estimator.flush (function).
estimator.invariant (function).
estimator.replace-batch (function).
make-sample (function).
quantile (class).
sample (class).
sample-delta (generic reader).
(setf sample-delta) (generic writer).
sample-rank (generic reader).
(setf sample-rank) (generic writer).
sample-successor (generic reader).
(setf sample-successor) (generic writer).
sample-value (generic reader).
(setf sample-value) (generic writer).

Next: Indexes, Previous: Packages, Up: The quantile-estimator Reference Manual [Contents][Index]

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

Public Interface
Internals

Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]

Next: Generic functions, Previous: Public Interface, Up: Public Interface [Contents][Index]

6.1.1 Ordinary functions

Function: estimator.observe (estimator value) ¶

Package: quantile-estimator.
Source: estimator.lisp.

Function: estimator.query (estimator rank) ¶

Package: quantile-estimator.
Source: estimator.lisp.

Function: make-estimator (&rest invariants) ¶

Package: quantile-estimator.
Source: estimator.lisp.

Function: make-quantile (quantile inaccuracy) ¶

Package: quantile-estimator.
Source: quantile.lisp.

Function: quantile.delta (q rank n) ¶

Package: quantile-estimator.
Source: quantile.lisp.

Previous: Ordinary functions, Up: Public Interface [Contents][Index]

6.1.2 Generic functions

Generic Reader: estimator-invariants (object) ¶

Package

quantile-estimator.

Methods

Reader Method: estimator-invariants ((estimator estimator)) ¶

automatically generated reader method

Source: estimator.lisp.
Target Slot: invariants.

Generic Reader: estimator-observations (object) ¶

Package

quantile-estimator.

Methods

Reader Method: estimator-observations ((estimator estimator)) ¶

automatically generated reader method

Source: estimator.lisp.
Target Slot: observations.

Generic Writer: (setf estimator-observations) (object) ¶

Package

quantile-estimator.

Methods

Writer Method: (setf estimator-observations) ((estimator estimator)) ¶

automatically generated writer method

Source: estimator.lisp.
Target Slot: observations.

Generic Reader: estimator-sum (object) ¶

Package

quantile-estimator.

Methods

Reader Method: estimator-sum ((estimator estimator)) ¶

automatically generated reader method

Source: estimator.lisp.
Target Slot: sum.

Generic Writer: (setf estimator-sum) (object) ¶

Package

quantile-estimator.

Methods

Writer Method: (setf estimator-sum) ((estimator estimator)) ¶

automatically generated writer method

Source: estimator.lisp.
Target Slot: sum.

Generic Reader: quantile-inaccuracy (object) ¶

Package

quantile-estimator.

Methods

Reader Method: quantile-inaccuracy ((quantile quantile)) ¶

automatically generated reader method

Source: quantile.lisp.
Target Slot: inaccuracy.

Generic Reader: quantile-quantile (object) ¶

Package

quantile-estimator.

Methods

Reader Method: quantile-quantile ((quantile quantile)) ¶

automatically generated reader method

Source: quantile.lisp.
Target Slot: quantile.

Previous: Public Interface, Up: Definitions [Contents][Index]

6.2 Internals

Constants
Ordinary functions
Generic functions
Classes

Next: Ordinary functions, Previous: Internals, Up: Internals [Contents][Index]

6.2.1 Constants

Constant: +buffer-size+ ¶

Package: quantile-estimator.
Source: estimator.lisp.

Next: Generic functions, Previous: Constants, Up: Internals [Contents][Index]

6.2.2 Ordinary functions

Function: estimator.compress (estimator) ¶

Package: quantile-estimator.
Source: estimator.lisp.

Function: estimator.flush (estimator) ¶

Package: quantile-estimator.
Source: estimator.lisp.

Function: estimator.invariant (estimator rank) ¶

Package: quantile-estimator.
Source: estimator.lisp.

Function: estimator.replace-batch (estimator) ¶

Package: quantile-estimator.
Source: estimator.lisp.

Function: make-sample (value rank delta successor) ¶

Package: quantile-estimator.
Source: estimator.lisp.

Next: Classes, Previous: Ordinary functions, Up: Internals [Contents][Index]

6.2.3 Generic functions

Generic Reader: sample-delta (object) ¶

Package

quantile-estimator.

Methods

Reader Method: sample-delta ((sample sample)) ¶

automatically generated reader method

Source: estimator.lisp.
Target Slot: delta.

Generic Writer: (setf sample-delta) (object) ¶

Package

quantile-estimator.

Methods

Writer Method: (setf sample-delta) ((sample sample)) ¶

automatically generated writer method

Source: estimator.lisp.
Target Slot: delta.

Generic Reader: sample-rank (object) ¶

Package

quantile-estimator.

Methods

Reader Method: sample-rank ((sample sample)) ¶

automatically generated reader method

Source: estimator.lisp.
Target Slot: rank.

Generic Writer: (setf sample-rank) (object) ¶

Package

quantile-estimator.

Methods

Writer Method: (setf sample-rank) ((sample sample)) ¶

automatically generated writer method

Source: estimator.lisp.
Target Slot: rank.

Generic Reader: sample-successor (object) ¶

Package

quantile-estimator.

Methods

Reader Method: sample-successor ((sample sample)) ¶

automatically generated reader method

Source: estimator.lisp.
Target Slot: successor.

Generic Writer: (setf sample-successor) (object) ¶

Package

quantile-estimator.

Methods

Writer Method: (setf sample-successor) ((sample sample)) ¶

automatically generated writer method

Source: estimator.lisp.
Target Slot: successor.

Generic Reader: sample-value (object) ¶

Package

quantile-estimator.

Methods

Reader Method: sample-value ((sample sample)) ¶

automatically generated reader method

Source: estimator.lisp.
Target Slot: value.

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

Package

quantile-estimator.

Methods

Writer Method: (setf sample-value) ((sample sample)) ¶

automatically generated writer method

Source: estimator.lisp.
Target Slot: value.

Previous: Generic functions, Up: Internals [Contents][Index]

6.2.4 Classes

Class: estimator ¶

Package

quantile-estimator.

Source

estimator.lisp.

Direct methods

estimator-invariants.
(setf estimator-observations).
estimator-observations.
(setf estimator-sum).
estimator-sum.

Direct slots

Slot: invariants ¶

Initargs: :invariants
Readers: estimator-invariants.
Writers: This slot is read-only.

Slot: buffer ¶

Initform: (make-array quantile-estimator::+buffer-size+)
Initargs: :buffer

Slot: buffer-pos ¶

Initform: 0
Initargs: :buffer-pos

Slot: head ¶

Initargs: :head

Slot: observations ¶

Initform: 0
Readers: estimator-observations.
Writers: (setf estimator-observations).

Slot: sum ¶

Initform: 0
Readers: estimator-sum.
Writers: (setf estimator-sum).

Class: quantile ¶

Package

quantile-estimator.

Source

quantile.lisp.

Direct methods

quantile-inaccuracy.
quantile-quantile.

Direct slots

Slot: quantile ¶

Initargs: :quantile
Readers: quantile-quantile.
Writers: This slot is read-only.

Slot: inaccuracy ¶

Initargs: :inaccuracy
Readers: quantile-inaccuracy.
Writers: This slot is read-only.

Slot: coefficient_i ¶

Initargs: :coefficient_i

Slot: coefficient_ii ¶

Initargs: :coefficient_ii

Class: sample ¶

Package

quantile-estimator.

Source

estimator.lisp.

Direct methods

(setf sample-delta).
sample-delta.
(setf sample-rank).
sample-rank.
(setf sample-successor).
sample-successor.
(setf sample-value).
sample-value.

Direct slots

Slot: value ¶

Initargs: :value
Readers: sample-value.
Writers: (setf sample-value).

Slot: rank ¶

Initargs: :rank
Readers: sample-rank.
Writers: (setf sample-rank).

Slot: delta ¶

Initargs: :delta
Readers: sample-delta.
Writers: (setf sample-delta).

Slot: successor ¶

Initargs: :successor
Readers: sample-successor.
Writers: (setf sample-successor).

Previous: Definitions, Up: The quantile-estimator Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

Next: Functions, Previous: Indexes, Up: Indexes [Contents][Index]

A.1 Concepts

Next: Variables, Previous: Concepts, Up: Indexes [Contents][Index]

A.2 Functions

Jump to:	( E F G M Q S

	Index Entry	Section

(
	`(setf estimator-observations)`:	Public generic functions
	`(setf estimator-observations)`:	Public generic functions
	`(setf estimator-sum)`:	Public generic functions
	`(setf estimator-sum)`:	Public generic functions
	`(setf sample-delta)`:	Private generic functions
	`(setf sample-delta)`:	Private generic functions
	`(setf sample-rank)`:	Private generic functions
	`(setf sample-rank)`:	Private generic functions
	`(setf sample-successor)`:	Private generic functions
	`(setf sample-successor)`:	Private generic functions
	`(setf sample-value)`:	Private generic functions
	`(setf sample-value)`:	Private generic functions

E
	`estimator-invariants`:	Public generic functions
	`estimator-invariants`:	Public generic functions
	`estimator-observations`:	Public generic functions
	`estimator-observations`:	Public generic functions
	`estimator-sum`:	Public generic functions
	`estimator-sum`:	Public generic functions
	`estimator.compress`:	Private ordinary functions
	`estimator.flush`:	Private ordinary functions
	`estimator.invariant`:	Private ordinary functions
	`estimator.observe`:	Public ordinary functions
	`estimator.query`:	Public ordinary functions
	`estimator.replace-batch`:	Private ordinary functions

F
	`Function, estimator.compress`:	Private ordinary functions
	`Function, estimator.flush`:	Private ordinary functions
	`Function, estimator.invariant`:	Private ordinary functions
	`Function, estimator.observe`:	Public ordinary functions
	`Function, estimator.query`:	Public ordinary functions
	`Function, estimator.replace-batch`:	Private ordinary functions
	`Function, make-estimator`:	Public ordinary functions
	`Function, make-quantile`:	Public ordinary functions
	`Function, make-sample`:	Private ordinary functions
	`Function, quantile.delta`:	Public ordinary functions

G
	`Generic Function, (setf estimator-observations)`:	Public generic functions
	`Generic Function, (setf estimator-sum)`:	Public generic functions
	`Generic Function, (setf sample-delta)`:	Private generic functions
	`Generic Function, (setf sample-rank)`:	Private generic functions
	`Generic Function, (setf sample-successor)`:	Private generic functions
	`Generic Function, (setf sample-value)`:	Private generic functions
	`Generic Function, estimator-invariants`:	Public generic functions
	`Generic Function, estimator-observations`:	Public generic functions
	`Generic Function, estimator-sum`:	Public generic functions
	`Generic Function, quantile-inaccuracy`:	Public generic functions
	`Generic Function, quantile-quantile`:	Public generic functions
	`Generic Function, sample-delta`:	Private generic functions
	`Generic Function, sample-rank`:	Private generic functions
	`Generic Function, sample-successor`:	Private generic functions
	`Generic Function, sample-value`:	Private generic functions

M
	`make-estimator`:	Public ordinary functions
	`make-quantile`:	Public ordinary functions
	`make-sample`:	Private ordinary functions
	`Method, (setf estimator-observations)`:	Public generic functions
	`Method, (setf estimator-sum)`:	Public generic functions
	`Method, (setf sample-delta)`:	Private generic functions
	`Method, (setf sample-rank)`:	Private generic functions
	`Method, (setf sample-successor)`:	Private generic functions
	`Method, (setf sample-value)`:	Private generic functions
	`Method, estimator-invariants`:	Public generic functions
	`Method, estimator-observations`:	Public generic functions
	`Method, estimator-sum`:	Public generic functions
	`Method, quantile-inaccuracy`:	Public generic functions
	`Method, quantile-quantile`:	Public generic functions
	`Method, sample-delta`:	Private generic functions
	`Method, sample-rank`:	Private generic functions
	`Method, sample-successor`:	Private generic functions
	`Method, sample-value`:	Private generic functions

Q
	`quantile-inaccuracy`:	Public generic functions
	`quantile-inaccuracy`:	Public generic functions
	`quantile-quantile`:	Public generic functions
	`quantile-quantile`:	Public generic functions
	`quantile.delta`:	Public ordinary functions

S
	`sample-delta`:	Private generic functions
	`sample-delta`:	Private generic functions
	`sample-rank`:	Private generic functions
	`sample-rank`:	Private generic functions
	`sample-successor`:	Private generic functions
	`sample-successor`:	Private generic functions
	`sample-value`:	Private generic functions
	`sample-value`:	Private generic functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	+ B C D H I O Q R S V

	Index Entry	Section

+
	`+buffer-size+`:	Private constants

B
	`buffer`:	Private classes
	`buffer-pos`:	Private classes

C
	`coefficient_i`:	Private classes
	`coefficient_ii`:	Private classes
	`Constant, +buffer-size+`:	Private constants

D
	`delta`:	Private classes

H
	`head`:	Private classes

I
	`inaccuracy`:	Private classes
	`invariants`:	Private classes

O
	`observations`:	Private classes

Q
	`quantile`:	Private classes

R
	`rank`:	Private classes

S
	`Slot, buffer`:	Private classes
	`Slot, buffer-pos`:	Private classes
	`Slot, coefficient_i`:	Private classes
	`Slot, coefficient_ii`:	Private classes
	`Slot, delta`:	Private classes
	`Slot, head`:	Private classes
	`Slot, inaccuracy`:	Private classes
	`Slot, invariants`:	Private classes
	`Slot, observations`:	Private classes
	`Slot, quantile`:	Private classes
	`Slot, rank`:	Private classes
	`Slot, successor`:	Private classes
	`Slot, sum`:	Private classes
	`Slot, value`:	Private classes
	`successor`:	Private classes
	`sum`:	Private classes

V
	`value`:	Private classes

Previous: Variables, Up: Indexes [Contents][Index]

A.4 Data types

Jump to:	C E F M P Q S

	Index Entry	Section

C
	`Class, estimator`:	Private classes
	`Class, quantile`:	Private classes
	`Class, sample`:	Private classes

E
	`estimator`:	Private classes
	`estimator.lisp`:	The quantile-estimator/src/estimator․lisp file

F
	`File, estimator.lisp`:	The quantile-estimator/src/estimator․lisp file
	`File, package.lisp`:	The quantile-estimator/src/package․lisp file
	`File, quantile-estimator.asd`:	The quantile-estimator/quantile-estimator․asd file
	`File, quantile.lisp`:	The quantile-estimator/src/quantile․lisp file

M
	`Module, src`:	The quantile-estimator/src module

P
	`Package, quantile-estimator`:	The quantile-estimator package
	`package.lisp`:	The quantile-estimator/src/package․lisp file

Q
	`quantile`:	Private classes
	`quantile-estimator`:	The quantile-estimator system
	`quantile-estimator`:	The quantile-estimator package
	`quantile-estimator.asd`:	The quantile-estimator/quantile-estimator․asd file
	`quantile.lisp`:	The quantile-estimator/src/quantile․lisp file

S
	`sample`:	Private classes
	`src`:	The quantile-estimator/src module
	`System, quantile-estimator`:	The quantile-estimator system

The quantile-estimator Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 quantile-estimator

3 Modules

3.1 quantile-estimator/src

4 Files

4.1 Lisp

4.1.1 quantile-estimator/quantile-estimator.asd

4.1.2 quantile-estimator/src/package.lisp

4.1.3 quantile-estimator/src/quantile.lisp

4.1.4 quantile-estimator/src/estimator.lisp

5 Packages

5.1 quantile-estimator

6 Definitions

6.1 Public Interface

6.1.1 Ordinary functions

6.1.2 Generic functions

6.2 Internals

6.2.1 Constants

6.2.2 Ordinary functions

6.2.3 Generic functions

6.2.4 Classes

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `quantile-estimator`

3.1 `quantile-estimator/src`

4.1.1 `quantile-estimator/quantile-estimator.asd`

4.1.2 `quantile-estimator/src/package.lisp`

4.1.3 `quantile-estimator/src/quantile.lisp`

4.1.4 `quantile-estimator/src/estimator.lisp`

5.1 `quantile-estimator`