File stards.h¶

FileList > include > stards.h

#include <algorithm>
#include <cmath>
#include <cstdint>
#include <cstring>
#include <fstream>
#include <iomanip>
#include <iostream>
#include <memory>
#include <numeric>
#include <sstream>
#include <stdexcept>
#include <string>
#include <type_traits>
#include <map>
#include <set>
#include <unordered_map>
#include <unordered_set>
#include <variant>
#include <vector>
#include <chrono>
#include <atomic>
#include <shared_mutex>
#include <mutex>
#include <thread>
#include <queue>
#include <functional>
#include <condition_variable>
#include <future>
#include <optional>
#include <ctime>
#include <tuple>
#include <fcntl.h>
#include <unistd.h>
#include <zlib.h>
#include <lz4.h>
#include <curl/curl.h>
#include <openssl/sha.h>
#include <openssl/hmac.h>
#include <dirent.h>
#include <streambuf>
#include <utility>
#include <array>

Namespaces¶

Type	Name
namespace	star
namespace	logger
namespace	s3crypto
namespace	shuffle_detail

Classes¶

Type	Name
class	AWSConfigParser AWS Configuration file parser.
class	AWSTokenCache AWS SSO Token Cache reader.
class	AWSV4Signer AWS Signature Version 4 signer.
struct	BlockInfo Metadata for a single compressed block.
struct	BlockMap Maps logical elements to physical blocks.
struct	ByteUnshuffleSpec Describes an in-place byte-unshuffle to fuse into an array's fill.
struct	ColdStorage Cold storage - infrequently accessed data.
struct	ExtractionPlan Describes how to extract elements from blocks.
struct	ElementRange
struct	FileHeader File header structure (31 bytes fixed size).
struct	FilePathInfo
struct	HotStorage Hot storage - frequently accessed data (cache-friendly).
class	HttpRangeReader
struct	IndexEntry Index entry with block compression support and shape information.
struct	KeyRegistry Global key registry using data-oriented design (Structure of Arrays).
class	LayerMetadataAccessor Metadata accessor for a specific layer with inheritance.
struct	LayerMetadataRegistry Per-layer metadata registry using data-oriented design (Structure of Arrays).
class	LayerView Lightweight view into a specific layer with inheritance from base.
class	LocalRangeReader
class	MemoryRangeReader
class	MetadataAccessor Accessor for metadata operations.
struct	MetadataValue Type-erased wrapper for metadata values.
class	NDArray <typename T> Modern n-dimensional array class with xtensor-style API.
struct	OpenOptions Read-time options for StarDataset::open() .
class	RangeReader
struct	S3Credentials AWS Credentials with resolution chain.
struct	S3EndpointConfig S3 endpoint resolution (default AWS, or an override for S3-compatible services such as MinIO and for local testing).
class	S3RangeReader
class	S3Writer S3 writer for uploading objects.
struct	HeaderData
struct	Slice Describes a slice along one dimension (Python-style slicing) Plain struct - no methods except helpers, just data.
struct	SliceSpec Complete slice specification for n-dimensional array.
struct	StarConfig Configuration for metadata block optimization.
class	StarDataset A cloud-optimized binary key-value store for serializable data types.
class	ThreadPool Simple thread pool for parallel block operations.
struct	TypeToDataType <typename T>
struct	TypeToDataType< double > <>
struct	TypeToDataType< float > <>
struct	TypeToDataType< int16_t > <>
struct	TypeToDataType< int32_t > <>
struct	TypeToDataType< int64_t > <>
struct	TypeToDataType< int8_t > <>
struct	TypeToDataType< std::string > <>
struct	TypeToDataType< uint16_t > <>
struct	TypeToDataType< uint32_t > <>
struct	TypeToDataType< uint64_t > <>
struct	TypeToDataType< uint8_t > <>

Macros¶

Type	Name
define	LOG_DEBUG (...) `do { if (logger::STARDS\_DEBUG >= logger::current\_log\_level) logger::log\_internal(logger::STARDS\_DEBUG, \_\_LINE\_\_, \_\_func\_\_, \_\_VA\_ARGS\_\_); } while(0)`
define	LOG_ERROR (...) `do { if (logger::STARDS\_ERROR >= logger::current\_log\_level) logger::log\_internal(logger::STARDS\_ERROR, \_\_LINE\_\_, \_\_func\_\_, \_\_VA\_ARGS\_\_); } while(0)`
define	LOG_INFO (...) `do { if (logger::STARDS\_INFO >= logger::current\_log\_level) logger::log\_internal(logger::STARDS\_INFO, \_\_LINE\_\_, \_\_func\_\_, \_\_VA\_ARGS\_\_); } while(0)`
define	LOG_TRACE (...) `do { if (logger::STARDS\_TRACE >= logger::current\_log\_level) logger::log\_internal(logger::STARDS\_TRACE, \_\_LINE\_\_, \_\_func\_\_, \_\_VA\_ARGS\_\_); } while(0)`
define	LOG_WARN (...) `do { if (logger::STARDS\_WARN >= logger::current\_log\_level) logger::log\_internal(logger::STARDS\_WARN, \_\_LINE\_\_, \_\_func\_\_, \_\_VA\_ARGS\_\_); } while(0)`
define	STARDS_IS_BIG_ENDIAN `0`
define	STAR_STRINGIFY (x) `STAR\_STRINGIFY\_IMPL(x)`
define	STAR_STRINGIFY_IMPL (x) `#x`
define	STAR_VERSION_MAJOR `1`
define	STAR_VERSION_MINOR `0`
define	STAR_VERSION_PATCH `0`
define	STAR_VERSION_STRING `/* multi line expression */`

Macro Definition Documentation¶

define LOG_DEBUG¶

#define LOG_DEBUG (
    ...
) `do { if (logger::STARDS_DEBUG >= logger::current_log_level) logger::log_internal(logger::STARDS_DEBUG, __LINE__, __func__, __VA_ARGS__); } while(0)`

define LOG_ERROR¶

#define LOG_ERROR (
    ...
) `do { if (logger::STARDS_ERROR >= logger::current_log_level) logger::log_internal(logger::STARDS_ERROR, __LINE__, __func__, __VA_ARGS__); } while(0)`

define LOG_INFO¶

#define LOG_INFO (
    ...
) `do { if (logger::STARDS_INFO >= logger::current_log_level) logger::log_internal(logger::STARDS_INFO, __LINE__, __func__, __VA_ARGS__); } while(0)`

define LOG_TRACE¶

#define LOG_TRACE (
    ...
) `do { if (logger::STARDS_TRACE >= logger::current_log_level) logger::log_internal(logger::STARDS_TRACE, __LINE__, __func__, __VA_ARGS__); } while(0)`

define LOG_WARN¶

#define LOG_WARN (
    ...
) `do { if (logger::STARDS_WARN >= logger::current_log_level) logger::log_internal(logger::STARDS_WARN, __LINE__, __func__, __VA_ARGS__); } while(0)`

define STARDS_IS_BIG_ENDIAN¶

#define STARDS_IS_BIG_ENDIAN `0`

define STAR_STRINGIFY¶

#define STAR_STRINGIFY (
    x
) `STAR_STRINGIFY_IMPL(x)`

define STAR_STRINGIFY_IMPL¶

#define STAR_STRINGIFY_IMPL (
    x
) `#x`

define STAR_VERSION_MAJOR¶

#define STAR_VERSION_MAJOR `1`

define STAR_VERSION_MINOR¶

#define STAR_VERSION_MINOR `0`

define STAR_VERSION_PATCH¶

#define STAR_VERSION_PATCH `0`

define STAR_VERSION_STRING¶

#define STAR_VERSION_STRING `/* multi line expression */`

The documentation for this class was generated from the following file StarDS/include/stards.h