The quantile-estimator Reference Manual

Next: , Previous: , 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 Aug 15 05:41:12 2022 GMT+0.

Table of Contents


1 Introduction

Quantile estimator for streams Build Status Coverage Status

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

Based on Ruby Implementation.

(let ((estimator (make-estimator)))
  (estimator.observe estimator 0.8)
  (estimator.observe estimator 0.4)
  (estimator.observe estimator 0.9)
  (estimator.observe estimator 0.6)

  (is (estimator.query estimator 0.5) 0.6)
  (is (estimator.query estimator 0.9) 0.8)
  (is (estimator.query estimator 0.99) 0.8))

License

MIT


2 Systems

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


Previous: , 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).


3 Modules

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


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

3.1 quantile-estimator/src

Source

quantile-estimator.asd.

Parent Component

quantile-estimator (system).

Child Components

4 Files

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


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

4.1 Lisp


4.1.1 quantile-estimator/quantile-estimator.asd

Source

quantile-estimator.asd.

Parent Component

quantile-estimator (system).

ASDF Systems

quantile-estimator.


4.1.2 quantile-estimator/src/package.lisp

Source

quantile-estimator.asd.

Parent Component

src (module).

Packages

quantile-estimator.


4.1.3 quantile-estimator/src/quantile.lisp

Dependency

package.lisp (file).

Source

quantile-estimator.asd.

Parent Component

src (module).

Public Interface
Internals

quantile (class).


4.1.4 quantile-estimator/src/estimator.lisp

Dependency

quantile.lisp (file).

Source

quantile-estimator.asd.

Parent Component

src (module).

Public Interface
Internals

5 Packages

Packages are listed by definition order.


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

5.1 quantile-estimator

Source

package.lisp.

Use List
  • alexandria.
  • common-lisp.
Public Interface
Internals

6 Definitions

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


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

6.1 Public Interface


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.


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.


6.2 Internals


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

6.2.1 Constants

Constant: +buffer-size+
Package

quantile-estimator.

Source

estimator.lisp.


Next: , Previous: , 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: , Previous: , 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: , Up: Internals   [Contents][Index]

6.2.4 Classes

Class: estimator
Package

quantile-estimator.

Source

estimator.lisp.

Direct methods
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
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
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).


Appendix A Indexes


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

A.1 Concepts


Next: , Previous: , 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

Jump to:   (  
E   F   G   M   Q   S