The quantile-estimator.cl Reference Manual

Table of Contents

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

The quantile-estimator.cl Reference Manual

This is the quantile-estimator.cl Reference Manual, version 0.0.1, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 04:29:08 2018 GMT+0.


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

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


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

2 Systems

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


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

2.1 quantile-estimator

Author

Ilya Khaprov <ilya.kharpov@publitechs.com>

License

MIT

Description

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

Version

0.0.1

Dependency

alexandria

Source

quantile-estimator.asd (file)

Component

src (module)


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

3 Modules

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


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

3.1 quantile-estimator/src

Parent

quantile-estimator (system)

Location

src/

Components

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

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


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 quantile-estimator.asd

Location

quantile-estimator.asd

Systems

quantile-estimator (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.2 quantile-estimator/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

quantile-estimator


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.3 quantile-estimator/src/quantile.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/quantile.lisp

Exported Definitions
Internal Definitions

quantile (class)


Previous: , Up: Lisp files   [Contents][Index]

4.1.4 quantile-estimator/src/estimator.lisp

Dependency

quantile.lisp (file)

Parent

src (module)

Location

src/estimator.lisp

Exported Definitions
Internal Definitions

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

5 Packages

Packages are listed by definition order.


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

5.1 quantile-estimator

Source

package.lisp (file)

Use List
Exported Definitions
Internal Definitions

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

6 Definitions

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


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

6.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.1 Functions

Function: estimator.observe ESTIMATOR VALUE
Package

quantile-estimator

Source

estimator.lisp (file)

Function: estimator.query ESTIMATOR RANK
Package

quantile-estimator

Source

estimator.lisp (file)

Function: make-estimator &rest INVARIANTS
Package

quantile-estimator

Source

estimator.lisp (file)

Function: make-quantile QUANTILE INACCURACY
Package

quantile-estimator

Source

quantile.lisp (file)

Function: quantile.delta Q RANK N
Package

quantile-estimator

Source

quantile.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

6.1.2 Generic functions

Generic Function: estimator-invariants OBJECT
Package

quantile-estimator

Methods
Method: estimator-invariants (ESTIMATOR estimator)

automatically generated reader method

Source

estimator.lisp (file)

Generic Function: estimator-observations OBJECT
Generic Function: (setf estimator-observations) NEW-VALUE OBJECT
Package

quantile-estimator

Methods
Method: estimator-observations (ESTIMATOR estimator)

automatically generated reader method

Source

estimator.lisp (file)

Method: (setf estimator-observations) NEW-VALUE (ESTIMATOR estimator)

automatically generated writer method

Source

estimator.lisp (file)

Generic Function: estimator-sum OBJECT
Generic Function: (setf estimator-sum) NEW-VALUE OBJECT
Package

quantile-estimator

Methods
Method: estimator-sum (ESTIMATOR estimator)

automatically generated reader method

Source

estimator.lisp (file)

Method: (setf estimator-sum) NEW-VALUE (ESTIMATOR estimator)

automatically generated writer method

Source

estimator.lisp (file)

Generic Function: quantile-inaccuracy OBJECT
Package

quantile-estimator

Methods
Method: quantile-inaccuracy (QUANTILE quantile)

automatically generated reader method

Source

quantile.lisp (file)

Generic Function: quantile-quantile OBJECT
Package

quantile-estimator

Methods
Method: quantile-quantile (QUANTILE quantile)

automatically generated reader method

Source

quantile.lisp (file)


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

6.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.1 Constants

Constant: +buffer-size+
Package

quantile-estimator

Source

estimator.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.2 Functions

Function: estimator.compress ESTIMATOR
Package

quantile-estimator

Source

estimator.lisp (file)

Function: estimator.flush ESTIMATOR
Package

quantile-estimator

Source

estimator.lisp (file)

Function: estimator.invariant ESTIMATOR RANK
Package

quantile-estimator

Source

estimator.lisp (file)

Function: estimator.replace-batch ESTIMATOR
Package

quantile-estimator

Source

estimator.lisp (file)

Function: make-sample VALUE RANK DELTA SUCCESSOR
Package

quantile-estimator

Source

estimator.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.3 Generic functions

Generic Function: sample-delta OBJECT
Generic Function: (setf sample-delta) NEW-VALUE OBJECT
Package

quantile-estimator

Methods
Method: sample-delta (SAMPLE sample)

automatically generated reader method

Source

estimator.lisp (file)

Method: (setf sample-delta) NEW-VALUE (SAMPLE sample)

automatically generated writer method

Source

estimator.lisp (file)

Generic Function: sample-rank OBJECT
Generic Function: (setf sample-rank) NEW-VALUE OBJECT
Package

quantile-estimator

Methods
Method: sample-rank (SAMPLE sample)

automatically generated reader method

Source

estimator.lisp (file)

Method: (setf sample-rank) NEW-VALUE (SAMPLE sample)

automatically generated writer method

Source

estimator.lisp (file)

Generic Function: sample-successor OBJECT
Generic Function: (setf sample-successor) NEW-VALUE OBJECT
Package

quantile-estimator

Methods
Method: sample-successor (SAMPLE sample)

automatically generated reader method

Source

estimator.lisp (file)

Method: (setf sample-successor) NEW-VALUE (SAMPLE sample)

automatically generated writer method

Source

estimator.lisp (file)

Generic Function: sample-value OBJECT
Generic Function: (setf sample-value) NEW-VALUE OBJECT
Package

quantile-estimator

Methods
Method: sample-value (SAMPLE sample)

automatically generated reader method

Source

estimator.lisp (file)

Method: (setf sample-value) NEW-VALUE (SAMPLE sample)

automatically generated writer method

Source

estimator.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

6.2.4 Classes

Class: estimator ()
Package

quantile-estimator

Source

estimator.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: invariants
Initargs

:invariants

Readers

estimator-invariants (generic function)

Slot: buffer
Initargs

:buffer

Initform

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

Slot: buffer-pos
Initargs

:buffer-pos

Initform

0

Slot: head
Initargs

:head

Slot: observations
Initform

0

Readers

estimator-observations (generic function)

Writers

(setf estimator-observations) (generic function)

Slot: sum
Initform

0

Readers

estimator-sum (generic function)

Writers

(setf estimator-sum) (generic function)

Class: quantile ()
Package

quantile-estimator

Source

quantile.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: quantile
Initargs

:quantile

Readers

quantile-quantile (generic function)

Slot: inaccuracy
Initargs

:inaccuracy

Readers

quantile-inaccuracy (generic function)

Slot: coefficient_i
Initargs

:coefficient_i

Slot: coefficient_ii
Initargs

:coefficient_ii

Class: sample ()
Package

quantile-estimator

Source

estimator.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: value
Initargs

:value

Readers

sample-value (generic function)

Writers

(setf sample-value) (generic function)

Slot: rank
Initargs

:rank

Readers

sample-rank (generic function)

Writers

(setf sample-rank) (generic function)

Slot: delta
Initargs

:delta

Readers

sample-delta (generic function)

Writers

(setf sample-delta) (generic function)

Slot: successor
Initargs

:successor

Readers

sample-successor (generic function)

Writers

(setf sample-successor) (generic function)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   M   Q  
Index Entry  Section

F
File, Lisp, quantile-estimator.asd: The quantile-estimator<dot>asd file
File, Lisp, quantile-estimator/src/estimator.lisp: The quantile-estimator/src/estimator<dot>lisp file
File, Lisp, quantile-estimator/src/package.lisp: The quantile-estimator/src/package<dot>lisp file
File, Lisp, quantile-estimator/src/quantile.lisp: The quantile-estimator/src/quantile<dot>lisp file

L
Lisp File, quantile-estimator.asd: The quantile-estimator<dot>asd file
Lisp File, quantile-estimator/src/estimator.lisp: The quantile-estimator/src/estimator<dot>lisp file
Lisp File, quantile-estimator/src/package.lisp: The quantile-estimator/src/package<dot>lisp file
Lisp File, quantile-estimator/src/quantile.lisp: The quantile-estimator/src/quantile<dot>lisp file

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

Q
quantile-estimator.asd: The quantile-estimator<dot>asd file
quantile-estimator/src: The quantile-estimator/src module
quantile-estimator/src/estimator.lisp: The quantile-estimator/src/estimator<dot>lisp file
quantile-estimator/src/package.lisp: The quantile-estimator/src/package<dot>lisp file
quantile-estimator/src/quantile.lisp: The quantile-estimator/src/quantile<dot>lisp file

Jump to:   F   L   M   Q  

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

A.2 Functions

Jump to:   (  
E   F   G   M   Q   S  
Index Entry  Section

(
(setf estimator-observations): Exported generic functions
(setf estimator-observations): Exported generic functions
(setf estimator-sum): Exported generic functions
(setf estimator-sum): Exported generic functions
(setf sample-delta): Internal generic functions
(setf sample-delta): Internal generic functions
(setf sample-rank): Internal generic functions
(setf sample-rank): Internal generic functions
(setf sample-successor): Internal generic functions
(setf sample-successor): Internal generic functions
(setf sample-value): Internal generic functions
(setf sample-value): Internal generic functions

E
estimator-invariants: Exported generic functions
estimator-invariants: Exported generic functions
estimator-observations: Exported generic functions
estimator-observations: Exported generic functions
estimator-sum: Exported generic functions
estimator-sum: Exported generic functions
estimator.compress: Internal functions
estimator.flush: Internal functions
estimator.invariant: Internal functions
estimator.observe: Exported functions
estimator.query: Exported functions
estimator.replace-batch: Internal functions

F
Function, estimator.compress: Internal functions
Function, estimator.flush: Internal functions
Function, estimator.invariant: Internal functions
Function, estimator.observe: Exported functions
Function, estimator.query: Exported functions
Function, estimator.replace-batch: Internal functions
Function, make-estimator: Exported functions
Function, make-quantile: Exported functions
Function, make-sample: Internal functions
Function, quantile.delta: Exported functions

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

M
make-estimator: Exported functions
make-quantile: Exported functions
make-sample: Internal functions
Method, (setf estimator-observations): Exported generic functions
Method, (setf estimator-sum): Exported generic functions
Method, (setf sample-delta): Internal generic functions
Method, (setf sample-rank): Internal generic functions
Method, (setf sample-successor): Internal generic functions
Method, (setf sample-value): Internal generic functions
Method, estimator-invariants: Exported generic functions
Method, estimator-observations: Exported generic functions
Method, estimator-sum: Exported generic functions
Method, quantile-inaccuracy: Exported generic functions
Method, quantile-quantile: Exported generic functions
Method, sample-delta: Internal generic functions
Method, sample-rank: Internal generic functions
Method, sample-successor: Internal generic functions
Method, sample-value: Internal generic functions

Q
quantile-inaccuracy: Exported generic functions
quantile-inaccuracy: Exported generic functions
quantile-quantile: Exported generic functions
quantile-quantile: Exported generic functions
quantile.delta: Exported functions

S
sample-delta: Internal generic functions
sample-delta: Internal generic functions
sample-rank: Internal generic functions
sample-rank: Internal generic functions
sample-successor: Internal generic functions
sample-successor: Internal generic functions
sample-value: Internal generic functions
sample-value: Internal generic functions

Jump to:   (  
E   F   G   M   Q   S  

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

A.3 Variables

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

+
+buffer-size+: Internal constants

B
buffer: Internal classes
buffer-pos: Internal classes

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

D
delta: Internal classes

H
head: Internal classes

I
inaccuracy: Internal classes
invariants: Internal classes

O
observations: Internal classes

Q
quantile: Internal classes

R
rank: Internal classes

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

V
value: Internal classes

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

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

A.4 Data types

Jump to:   C   E   P   Q   S  
Index Entry  Section

C
Class, estimator: Internal classes
Class, quantile: Internal classes
Class, sample: Internal classes

E
estimator: Internal classes

P
Package, quantile-estimator: The quantile-estimator package

Q
quantile: Internal classes
quantile-estimator: The quantile-estimator system
quantile-estimator: The quantile-estimator package

S
sample: Internal classes
System, quantile-estimator: The quantile-estimator system

Jump to:   C   E   P   Q   S