dartframe library

Classes

AdaptiveCompression
Adaptive compression system Automatically selects the best codec based on data characteristics
ArrayDatatypeWriter
Writer for array HDF5 datatypes (fixed-size multidimensional arrays)
ArrayInfo
Array datatype information
ArrayUtils
Utility class providing static methods for array creation and manipulation.
Attributes
HDF5-style metadata attributes for data structures
AxisIndex
Axis index for N-dimensional arrays
BackendStats
Backend statistics for monitoring
BenchmarkComparison
Compare multiple benchmarks
BenchmarkResult
Benchmark result
BitfieldDatatypeWriter
Writer for bitfield HDF5 datatypes
BooleanDatatypeWriter
Writer for boolean HDF5 datatypes (stored as 8-bit enumeration)
BooleanDType
Nullable boolean type.
ByteReader
Efficient byte reader for HDF5 files with random access support
CacheEntry
Represents a cached entry with metadata.
CacheManager
Caching mechanisms for expensive DataFrame and Series operations.
CacheStats
Cache statistics for monitoring and debugging.
CategoricalAccessor
Categorical accessor for Series, similar to pandas .cat accessor.
CategoricalArray
Represents a MATLAB categorical array
Chunk
A chunk of data with metadata
ChunkCacheStats
Chunk cache statistics
ChunkedBackend
Chunked storage backend with LRU caching and advanced memory management
ChunkedLayout
Chunked data layout
ChunkedLayoutWriter
Writer for chunked storage layout
ChunkedReader
A class for reading large files in chunks to manage memory efficiently
ChunkManager
LRU cache for chunks
Codec
Abstract compression codec interface
CompactLayout
Compact data layout (data stored in message)
CompoundDatatypeWriter
Writer for compound HDF5 datatypes (structured data)
CompoundField
Compound datatype field information
CompoundInfo
Compound datatype information
CompressionRegistry
Global registry for compression codecs
CompressionResult
Result of compression test
ConnectionPool
Connection pool for managing database connections
ContiguousLayout
Contiguous data layout
ConversionOptions
Conversion options
CsvReader
Reader for CSV (Comma-Separated Values) files using the csv package.
DartData
Abstract base interface for all dimensional data structures in DartFrame
DatabaseConnection
Abstract base class for database connections
DatabaseDataSource
Database data source for SQL databases.
DatabaseReader
Database reader and writer utility class
DatabaseTransaction
Represents a database transaction
DataCharacteristics
Data characteristics for compression analysis
DataCube
A 3D data structure representing stacked DataFrames.
DataCubeDCF
Static methods for DataCube
DataCubeHDF5
Static methods for DataCube HDF5 operations.
DataCubeImport
Import utilities for DataCube
DataFrame
A DataFrame is a two-dimensional, size-mutable, potentially heterogeneous tabular data structure with labeled axes (rows and columns).
DataFrameColumnWriter
Writer for DataFrame objects using column-wise storage strategy
DataFrameCompoundWriter
Writer for DataFrame objects using compound datatype strategy
DataFrameILocAccessor
DataFrameLocAccessor
DataFrameRow
Represents a row from a DataFrame with named field access.
DataFrameStacker
Utility functions for DataFrame stacking and validation.
DataLayout
Base class for data layout types
DataReader
Abstract base class for data readers.
Dataset<T>
HDF5 dataset containing typed array data
DatasetInfo
Information about a dataset
DataSource
Abstract base class for data sources.
DataSourceRegistry
Registry for managing data source implementations.
DatatypeWriter
Base abstract class for HDF5 datatype writers
DatatypeWriterFactory
Factory for creating appropriate DatatypeWriter based on data type
DataWriter
Abstract base class for data writers.
DateTimeDType
DateTime type.
DatetimeIndex
A timezone-aware datetime index.
DCFChunkMetadata
Chunk metadata
DCFDatasetMetadata
Dataset metadata
DCFHeader
DCF File Layout:
DCFReader
DartCube File reader
DCFUtil
Utility class for DCF operations
DCFWriter
DartCube File writer
DType
Base class for all DartFrame data types.
DTypeRegistry
Registry for custom data types.
DTypes
Convenience functions for creating dtypes.
EnumDatatypeWriter
Writer for enumeration HDF5 datatypes (general enumerations)
EnumInfo
Enum datatype information
EnumMember
Enum datatype member
ExcelFileReader
Reader for Excel files (.xlsx, .xls) using the excel package.
ExpandingWindow
A class representing expanding window operations on a DataFrame.
ExponentialWeightedWindow
A class representing exponentially weighted window operations on a DataFrame.
ExtensionDType
Extension type base class.
FileDataSource
File system data source for loading data from local files.
FileIO
FileIOBase
A class to provide file input/output operations.
FileReader
Generic file reader that automatically detects and handles multiple file formats.
FileStats
File statistics information
FileWriter
Generic file writer that automatically detects and handles multiple file formats.
Filter
Base class for HDF5 filters
FilterId
HDF5 filter identifiers
FilterPipeline
Filter pipeline containing multiple filters
Fletcher32Filter
Fletcher32 checksum filter
Float32DType
Float types.
Float64DType
FormatConverter
Format converter
FrequencyUtils
Frequency utilities for time series operations
GlobalHeap
Global heap for storing variable-length data
GlobalHeapObject
A single object stored in a global heap collection
GlobalHeapWriter
Writer for HDF5 global heap collections
GlobalHeapWriterInternal
Writer for HDF5 global heaps
Group
HDF5 group containing datasets and other groups
GroupBy
A class representing a grouped DataFrame for split-apply-combine operations.
GzipCodec
Gzip compression codec Uses Dart's built-in gzip implementation
GzipFilter
Gzip/Deflate compression filter
Hdf5Attribute
HDF5 attribute containing metadata
Hdf5Dataspace
HDF5 dataspace representing array dimensions
Hdf5Datatype<T>
HDF5 datatype representation
Hdf5File
HDF5 file reader with pure Dart implementation
HDF5FileBuilder
Coordinator class for building complete HDF5 files
HDF5Reader
Reader for HDF5 files - integrates with dartframe
HDF5ReaderUtil
HDF5 Reader utility class.
HDF5ReadOptions
Options for HDF5 reading.
HDF5WriteOptions
Options for HDF5 writing.
HDF5Writer
Writer for HDF5 files - integrates with dartframe
HDF5WriterUtils
HDF5 Writer utility class.
HeapManager
Manages coordinated allocation across multiple heap types
HtmlTableParser
Enhanced HTML reading with advanced features.
HttpDataSource
HTTP/HTTPS data source for loading data from web URLs.
InMemoryBackend
In-memory storage backend
Int16DType
Int32DType
Int64DType
Int8DType
Nullable integer types.
JsonReader
Reader for JSON files with support for multiple orientations.
LazyBinaryOperation
Lazy element-wise binary operation between two arrays.
LazyMapOperation
Lazy map operation that applies a function to each element.
LazyNDArray
NDArray with lazy evaluation capabilities.
LazyOperation
Lazy operation that defers computation until needed.
LazyScalarOperation
Lazy scalar operation applying a function with a scalar value.
LinkInfo
Link information for group navigation
LinkMessage
Represents an HDF5 link message
ListComparisonResult
Result of list comparison with detailed information
ListEqualConfig
Configuration class for list comparison behavior
ListEqualPresets
Utility class for creating common configuration presets
LocalHeap
Local heap for storing variable-length data
LocalHeapWriter
Writer for HDF5 local heap
LocalHeapWriterInternal
Writer for HDF5 local heaps
LzfFilter
LZF compression filter
MatlabAttributes
MATLAB attribute name constants
MatlabDateTime
Represents a MATLAB datetime value
MatlabDuration
Represents a MATLAB duration value
MatlabObject
Represents a MATLAB object (custom class instance)
MatlabSpecialNames
MATLAB special dataset/group names
MatlabTypeMappings
Maps MATLAB types to Dart types
MatlabVariableInfo
Information about a MATLAB variable
MATReader
Reader for MATLAB .mat files (v7.3 only)
MATWriter
Public API for writing MATLAB v7.3 .mat files
MemoryEfficientLoader
Memory-efficient data loader for large datasets
MemoryEvent
Memory event
MemoryMonitor
Memory monitor for NDArray and DataCube Tracks memory usage across all storage backends
MemoryOptimizer
Memory optimization utilities for DartFrame.
MemoryStats
Memory statistics
MultiIndex
A multi-level or hierarchical index object.
MySQLConnection
MySQL database connection implementation using mysql_client package
NamedAgg
A class for named aggregations in groupby operations.
NDArray
N-dimensional array with flexible storage backends.
NDArrayConfig
Global configuration for NDArray and DataCube behavior
NDArrayDCF
Static methods for NDArray
NDArrayHDF5
Static methods for NDArray HDF5 operations.
NDArrayImport
Import utilities for NDArray
NoneCodec
No compression - data passes through unchanged
NumericDatatypeWriter
Writer for numeric HDF5 datatypes (integers and floating-point)
ObjectDType
Object type (any type).
ObjectHeader
HDF5 object header containing metadata messages
ObjectHeaderMessage
Individual message within an object header
OpaqueData
Opaque data wrapper with tag information
OpaqueDatatypeWriter
Writer for opaque HDF5 datatypes
ParallelConfig
Utility class for parallel operations configuration.
PerformanceOptimizer
Performance optimization utilities for DartFrame.
Period
Represents a time period.
PeriodIndex
PeriodIndex for time periods.
PostgreSQLConnection
PostgreSQL database connection implementation using postgres package
ProfileEntry
Statistics for a single profiled operation.
Profiler
A performance profiling system for tracking operation execution times and statistics.
ProfileReport
A report containing profiling statistics for multiple operations.
RandomAccessFileBase
Abstract interface for random access file operations
ReferenceDatatypeWriter
Writer for reference HDF5 datatypes
ReferenceInfo
Reference datatype information
RollingDataFrame
PREFERRED: Class providing comprehensive rolling window operations for DataFrame.
RollingSeries
Class providing rolling window operations for Series.
Scalar<T>
Scalar - 0-dimensional data structure
ScientificDatasets
Registry of popular scientific and machine learning datasets.
ScientificDataSource
Data source for scientific datasets using dataset:// URI scheme.
Series<T>
A Series class represents a one-dimensional array with a label.
SeriesDateTimeAccessor
Accessor for datetime-like properties of Series data.
Shape
Enhanced Shape class with N-dimensional support
ShuffleFilter
Shuffle filter for numeric data
Slice
Helper class for creating common slice specifications
SliceSpec
Slice specification for N-dimensional array slicing
SmartLoader
Smart loader that automatically detects and handles various data sources.
SparseMatrix
Represents a MATLAB sparse matrix
SparseTriplet
Represents a single non-zero element in a sparse matrix
SQLiteConnection
SQLite database connection implementation using sqlite3 package
StorageBackend
Abstract storage backend for N-dimensional arrays
StorageLayoutWriter
Base class for storage layout writers
StreamingDataProcessor
Streaming data processor for continuous data processing
StringDatatypeWriter
Writer for string HDF5 datatypes (fixed-length and variable-length)
StringDType
Nullable string type.
StringInfo
String-specific datatype information
StringSeriesAccessor
Superblock
HDF5 file superblock containing file metadata
SymbolTableEntry
Symbol table entry for group navigation
SymbolTableMessage
Symbol table message for old-style group storage
TimeDatatypeWriter
Writer for time HDF5 datatypes
TimedeltaIndex
TimedeltaIndex for time differences.
TimeSeriesIndex
Represents a time series index with timestamps and frequency information.
TimezoneInfo
Helper class for timezone-aware operations
UnsupportedFilter
Generic unsupported filter
VlenDatatypeWriter
Writer for variable-length HDF5 datatypes
VlenReference
Variable-length data reference
WriteOptions
Configuration options for HDF5 write operations
WrittenChunkInfo
Information about a written chunk
XmlParser
Enhanced XML reading with nested structure support.
ZlibCodec
Zlib compression codec Uses Dart's built-in zlib implementation Similar to Gzip but with different header

Enums

AccessPattern
Access pattern types
CharacterSet
Character set encoding
CompressionCodec
Compression codecs
CompressionStrategy
Compression strategy for adaptive selection
CompressionType
Compression algorithm types
DataFormat
Format types supported
DataFrameStorageStrategy
Storage strategy for DataFrame objects
DatatypeHint
Hint for explicit datatype specification when auto-detection is ambiguous
FileType
File type enumeration
Hdf5DatatypeClass
HDF5 datatype class enumeration
Hdf5ObjectType
Object type enumeration
HeapType
Type of heap for allocation
LinkType
Link types
ListComparisonMode
Comparison options for list equality checking
MatlabClass
MATLAB data class types as stored in HDF5 attributes
MemoryEventType
Memory event types
MessageType
HDF5 object header message types
ReferenceType
Reference type enumeration
StorageLayout
Storage layout for datasets
StringPaddingType
String padding types
VlenType
Variable-length type enumeration

Mixins

BackendStatsMixin
Mixin for backends that support statistics tracking
DartDataMixin
Mixin for common DartData functionality
DataFrameCaching
Mixin for adding caching capabilities to DataFrame operations.
SeriesCaching
Mixin for adding caching capabilities to Series operations.

Extensions

AdvancedIndexing on NDArray
Advanced indexing operations
DartDataConversion on DartData
Extension providing conversion methods for DartData types (NDArray, DataCube).
DataCubeAggregations on DataCube
Extension providing aggregation operations on DataCube.
DataCubeDCFWriter on DataCube
Extension for DataCube
DataCubeFormatConversion on DataCube
Extension for DataCube format conversion
DataCubeHDF5Reader on DataCube
Extension for reading HDF5 to DataCube.
DataCubeHDF5Writer on DataCube
Extension for writing DataCube to HDF5.
DataCubeImportExtension on DataCube
Extension methods for convenient imports
DataCubeIO on DataCube
Extension providing I/O operations for DataCube.
DataCubeSelection on DataCube
Extension for DataCube selection
DataCubeToDataFrame on DataCube
Extension methods for DataCube to DataFrame conversion.
DataCubeTransformations on DataCube
Extension providing transformation operations on DataCube.
DataFrameAdvancedSlicing on DataFrame
Advanced slicing operations for DataFrame
DataFrameAggregationAdvanced on DataFrame
Extension for advanced DataFrame aggregation operations
DataFrameAlignment on DataFrame
Extension for DataFrame alignment and reindexing methods
DataFrameCachingExtension on DataFrame
Extension methods for DataFrame caching.
DataFrameComparison on DataFrame
Extension for DataFrame comparison operations
DataFrameConditional on DataFrame
Extension for DataFrame conditional operations
DataFrameConversion on DataFrame
Extension providing conversion methods for DataFrame.
DataFrameDatabase on DataFrame
Extension to add database write capabilities to DataFrame
DataFrameDatetimeIndexSupport on DataFrame
Extension to integrate DatetimeIndex with DataFrame
DataFrameDType on DataFrame
Extension to add dtype support to DataFrame.
DataFrameDuplicateFunctions on DataFrame
DataFrameExportFormats on DataFrame
Extension providing export format methods for DataFrame.
DataFrameExpressionEvaluation on DataFrame
Extension for expression evaluation methods on DataFrame.
DataFrameFunctionalProgramming on DataFrame
DataFrameFunctions on DataFrame
DataFrameHDF5Writer on DataFrame
Extension for writing DataFrame to HDF5.
DataFrameInspection on DataFrame
Extension for DataFrame inspection methods
DataFrameInterpolation on DataFrame
Extension providing interpolation methods for DataFrame.
DataFrameIteration on DataFrame
Extension for DataFrame iteration methods
DataFrameMemoryOptimization on DataFrame
Extension methods for DataFrame memory optimization.
DataFrameMerging on DataFrame
Extension providing enhanced merge and join operations for DataFrame.
DataFrameMergingAdvanced on DataFrame
Extension for advanced DataFrame merging and joining operations
DataFrameMetadataFormatting on DataFrame
Extension for DataFrame metadata and formatting enhancements
DataFrameMissingDataAdvanced on DataFrame
Extension for advanced DataFrame missing data handling
DataFrameMissingDataAnalysis on DataFrame
Extension providing missing data analysis tools for DataFrame.
DataFrameMissingDataHelpers on DataFrame
Extension for DataFrame missing data helper methods
DataFrameMultiIndexSupport on DataFrame
Extension to integrate MultiIndex with DataFrame
DataFrameOperations on DataFrame
Extension providing data manipulation operations for DataFrame.
DataFrameResamplingEnhanced on DataFrame
Enhanced resampling operations for DataFrame
DataFrameReshaping on DataFrame
Extension providing advanced data reshaping operations for DataFrame.
DataFrameSamplingEnhanced on DataFrame
Enhanced sampling and selection operations for DataFrame
DataFrameSmartLoader on DataFrame
Extension to add smart loading capabilities to DataFrame.
DataFrameSortingEnhanced on DataFrame
Extension for enhanced DataFrame sorting operations
DataFrameStatistics on DataFrame
Extension providing advanced statistical operations for DataFrame.
DataFrameTimeSeries on DataFrame
Time series operations for DataFrame
DataFrameTimeSeriesAdvanced on DataFrame
Extension for advanced DataFrame time series operations
DataFrameTimezoneOperations on DataFrame
Timezone operations for DataFrame
DataFrameToDataCube on DataFrame
Extension methods for DataFrame to DataCube conversion.
DataFrameVectorizedOperations on DataFrame
Extension methods for DataFrame vectorized operations.
DataFrameWebAPI on DataFrame
Extension providing web and API methods for DataFrame.
DataFrameWindowFunctions on DataFrame
Extension to add window function methods to DataFrame.
IndexSetOperations on MultiIndex
Index set operations
LazyNDArrayExtension on NDArray
Extension methods for lazy evaluation
ListEqualityExtension on List<T>
Extension method to add comparison capabilities to lists
NDArrayDCFWriter on NDArray
Extension for NDArray
NDArrayFiltering on NDArray
Extension for filtering NDArray
NDArrayFormatConversion on NDArray
Extension for NDArray format conversion
NDArrayHDF5Reader on NDArray
Extension for reading HDF5 to NDArray.
NDArrayHDF5Writer on NDArray
Extension for writing NDArray to HDF5.
NDArrayImportExtension on NDArray
Extension methods for convenient imports
NDArrayOperations on NDArray
Extension providing mathematical and statistical operations on NDArray.
NDArrayTransformations on NDArray
Extension providing transformation operations on NDArray.
Parallel on NDArray
Extension providing parallel processing capabilities using isolates.
SeriesAlignment on Series
Extension for Series alignment and reindexing methods
SeriesCachingExtension on Series
Extension methods for Series caching.
SeriesComparison on Series
Extension for Series comparison operations
SeriesConditional on Series
Extension for Series conditional operations
SeriesConversion on Series
Extension providing conversion methods for Series.
SeriesDType on Series<T>
Extension to add dtype support to Series.
SeriesEnhancements on Series
Extension for Series enhancements
SeriesFunctions on Series
SeriesInspection on Series
Extension for Series inspection methods
SeriesInterpolation on Series
Extension providing interpolation methods for Series.
SeriesIteration on Series
Extension for Series iteration methods
SeriesMemoryOptimization on Series
Extension methods for Series memory optimization.
SeriesMissingDataAnalysis on Series
Extension providing missing data analysis tools for Series.
SeriesOperations on Series
SeriesStatistics on Series
Extension providing advanced statistical operations for Series.
SeriesVectorizedOperations on Series
Extension methods for Series vectorized operations.
SliceExtension on int
Extension to make slicing more convenient
Streaming on NDArray
Extension providing streaming and chunked processing capabilities.

Constants

datatypeClassArray → const int
datatypeClassBitfield → const int
datatypeClassCompound → const int
datatypeClassEnum → const int
datatypeClassFixedPoint → const int
Legacy constants for backward compatibility
datatypeClassFloatingPoint → const int
datatypeClassOpaque → const int
datatypeClassReference → const int
datatypeClassString → const int
datatypeClassTime → const int
datatypeClassVariableLength → const int
DCF_HEADER_SIZE → const int
Header size in bytes
DCF_MAGIC → const List<int>
Magic number for DCF files: "DCF\0"
DCF_VERSION → const int
DCF File Format Version

Properties

isHdf5DebugMode bool
Gets the current debug mode status
no setter

Functions

benchmark(String name, Future<void> operation(), {int iterations = 10, int warmupIterations = 2}) Future<BenchmarkResult>
Benchmark a function
benchmarkSync(String name, void operation(), {int iterations = 10, int warmupIterations = 2}) BenchmarkResult
Benchmark a synchronous function
calculateCRC32(List<int> data) int
Calculate CRC32 checksum
dateRange({DateTime? start, DateTime? end, int? periods, String freq = 'D', bool normalize = false, String name = 'dateRange'}) Series
Creates a Series of DateTime objects with a specified range.
hdf5DebugLog(String message) → void
Logs a debug message if debug mode is enabled
listEqual(List<List> lists, [ListEqualConfig config = const ListEqualConfig()]) bool
Comprehensive list equality comparison function
listEqualDetailed(List<List> lists, [ListEqualConfig config = const ListEqualConfig()]) ListComparisonResult
Extended version of listEqual that returns detailed comparison results
pow_(double base, double exponent) double
Helper function for power calculation
setHdf5DebugMode(bool enabled) → void
Sets the debug mode for HDF5 operations

Typedefs

DeflateFilter = GzipFilter
Legacy alias for backward compatibility
Hdf5DatatypeField = CompoundField
Alternative name for compound field (for new API)
HeaderMessage = ObjectHeaderMessage
Legacy alias for backward compatibility with writer code

Exceptions / Errors

AttributeValidationError
Error thrown when attribute validation fails
ChunkedReadError
Exception thrown when chunked reading fails
CircularLinkError
Error thrown when a circular soft link is detected
CorruptedFileError
Error thrown when file corruption is detected
CsvReadError
Exception thrown when CSV reading or parsing fails.
DatabaseConnectionError
Exception thrown when database connection fails
DatabaseQueryError
Exception thrown when database query fails
DatabaseTransactionError
Exception thrown when database transaction fails
DataReadError
Error thrown when data reading fails
DatasetNotFoundError
Error thrown when a dataset is not found
DataSourceError
Exception thrown when a data source operation fails
DataValidationError
Error thrown when data validation fails before writing
DecompressionError
Error thrown when decompression fails
ExcelReadError
Exception thrown when Excel reading or parsing fails.
FileAccessError
Error thrown when file access fails
FileWriteError
Error thrown when a write operation fails due to file system errors
GroupNotFoundError
Error thrown when a group is not found
GroupPathConflictError
Error thrown when a group path conflicts with an existing object
Hdf5Error
Base class for all HDF5 errors with comprehensive diagnostics
HDF5ReadError
Exception thrown when HDF5 reading fails @deprecated Use Hdf5Error and its subclasses instead
HDF5WriteError
Base class for HDF5 write errors
InsufficientSpaceError
Error thrown when insufficient disk space is detected
InvalidChunkDimensionsError
Error thrown when invalid chunk dimensions are provided
InvalidDatasetNameError
Error thrown when an invalid dataset name is provided
InvalidHdf5SignatureError
Error thrown when HDF5 signature is invalid
InvalidMessageError
Error thrown when an invalid message is encountered
InvalidSignatureError
Error thrown when an invalid signature is encountered
JsonReadError
Exception thrown when JSON reading fails.
ListComparisonException
Exception thrown when list comparison encounters an error
MatlabFileFormatError
Exception for MATLAB file format errors
MATReadError
Exception thrown when MATLAB reading fails
NotADatasetError
Error thrown when an object is not a dataset
NotAGroupError
Error thrown when an object is not a group
PathNotFoundError
Error thrown when a path is not found
StreamingProcessError
Exception thrown when streaming processing fails
UnsupportedDatabaseError
Exception thrown when database type is not supported
UnsupportedDatatypeError
Error thrown when an unsupported datatype is encountered
UnsupportedFeatureError
Error thrown when an unsupported feature is encountered
UnsupportedFormatError
Exception thrown when file format is not supported
UnsupportedMatlabTypeError
Exception for unsupported MATLAB types
UnsupportedVersionError
Error thrown when an unsupported version is encountered
UnsupportedWriteDatatypeError
Error thrown when attempting to write an unsupported datatype
UnsupportedWriteFormatError
Exception thrown when file format is not supported for writing
WriteInterruptedError
Error thrown when a write operation is interrupted