Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 79 additions & 0 deletions doc/glossary/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
Glossary
========

.. glossary::

block
The unit of decompression, stored within a chunk. Blocks are sized to
fit CPU caches, typically 32-512KB.

BUCKET
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua.

chunk
The unit of storage and compression, stored within a SChunk. Chunks are
sized to fit disk/network I/O, typically 1-64MB.

clevel
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua.

codec (:class:`API <blosc2.Codec>`)
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua.

compression parameters (:class:`API <blosc2.CParams>`)
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua.

CTable (:ref:`API <CTable>`)
A columnar table for structured data. Columns are stored, compressed, and
queried independently, with SUMMARY indexes available by default. Use with
structured data that benefits from compression, speed, and persistence.

filters (:class:`API <blosc2.Filter>`)
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua.

frame
A serialized format for storing chunks along with a header and trailer for
metadata. Frames may be contiguous (CFrame) or sparse (SFrame).

FULL
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua.

LazyArray (:ref:`API <LazyArray>`)
API to store an expression or function and delay computation until the
value is explicitly requested. Executes and stores results chunk-by-chunk.

LaxyExpr (:ref:`API <LazyExpr>`)
Object that stores an expression consisting of at least one NDArray
object. Follows the LazyArray API for storage and deferred computation.

NDArray (:ref:`API <NDArray>`)
A compressed, chunked multidimensional data array. Supports NumPy-like
slicing and broadcasting, and out-of-core computation. Backed by an SChunk.
Use for array workloads, especially when too large to fit in memory
uncompressed.

OPSI
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua.

PARTIAL
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua.

SChunk (:ref:`API <SChunk>`)
The foundational container for managing a sequence of individual,
compressed chunks. NDArrays and CTable columns are built on top of SChunk.
Use when you want to directly manipulate raw compresesd data and metadata.

subblock
An indexing segment within a block. One eighth the length of a block.

SUMMARY
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua.
1 change: 1 addition & 0 deletions doc/python-blosc2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -224,5 +224,6 @@
Tutorials <tutorials/index>
Guides <guides/index>
API Reference <reference/index>
Glossary <glossary/index>
Development <development/index>
Release Notes <release_notes/index>