# Package org.eclipse.january.dataset

- Interface Summary
  Interface | Description
  --- | ---
  BinaryOperation | Interface to represent a binary operation for implementations over different output domains
  CompoundDataset |
  Dataset | Interface for our implementation of dataset that adds a lot of extra functionality.
  DateDataset | Interface for a dataset containing `Date`s.
  IDataListener | Listener for data changes.
  IDataset | This interface defines the implementation-independent and generic parts of a dataset.
  IDatasetChangeChecker | Interface for a dataset checker to detect change
  IDatasetConnector | A dataset connector contains a lazy dataset which exists in a remote location.
  IDynamicDataset | This interface is intended for data sources that change dynamically.
  IDynamicShape | This interface is intended for data sources that change shape dynamically.
  IFileConnection |
  ILazyDataset | This interface defines the lazy parts of a dataset.
  ILazyWriteableDataset | This sub-interface adds the ability to write to a lazy dataset slice-by-slice
  IMetadataProvider | Interface which acts to provide metadata from an object
  IOperation | Marker interface for all operations
  IRemoteData | This class provides access to remote data which may consist of more than one remote dataset.
  UnaryOperation | Interface to represent a unary operation for implementations over different output domains

- Class Summary
  Class | Description
  --- | ---
  AbstractCompoundDataset | Generic container class for data that is compound in nature Each subclass has an array of compound types, items of this array are composed of primitive types Data items can be Complex, Vector, etc
  AbstractDataset | Generic container class for data Each subclass has an array of primitive types, elements of this array are grouped or compounded to make items Data items can be boolean, integer, float, complex float, vector float, etc
  AggregateDataset | Class to aggregate a set of lazy datasets and present them as a single lazy dataset where the first position value accesses the aggregation
  BinaryOperation.Stub | Stub class where only three methods need to be overridden: `BinaryOperation.Stub.complexOperate(double[], double, double, double, double)`, `BinaryOperation.Stub.toString(String, String)`
  BooleanBroadcastIterator | Class to run over a pair of datasets in parallel with NumPy broadcasting to promote shapes which have lower rank and outputs to a third dataset
  BooleanContiguousIterator | Class to run over a pair of contiguous datasets
  BooleanDataset | Extend boolean base dataset for boolean values
  BooleanDatasetBase | Extend dataset for boolean values // PRIM_TYPE
  BooleanIterator | Base class for boolean iterators for pairs of dataset where the second dataset could be broadcast to the first and is used to select where {`IndexIterator.hasNext()` returns true.
  BooleanNullIterator | Class to run over a single dataset with NumPy broadcasting to promote shapes which have lower rank and outputs to a second dataset
  BroadcastIterator | Base class for broadcast iterators of pairs with output.
  BroadcastIteratorBase | Base class for all broadcast iterators.
  BroadcastPairIterator | Class to run over a pair of datasets in parallel with NumPy broadcasting to promote shapes which have lower rank and outputs to a third dataset
  BroadcastSelfIterator | Base class for broadcast iterators where the second dataset could be broadcast to the first and it is also read into either bLong or bDouble fields.
  BroadcastSingleIterator | Class to run over a pair of datasets in parallel with NumPy broadcasting of second dataset
  BroadcastUtils |
  ByteDataset | Extend dataset for byte values // PRIM_TYPE
  CollectionStats | Statistics of data set lists.
  Comparisons | Comparison and logical methods
  ComplexDoubleDataset | Extend compound dataset to hold complex double values // PRIM_TYPE
  ComplexFloatDataset | Extend compound dataset to hold complex float values // PRIM_TYPE
  CompoundByteDataset | Extend compound dataset for byte values // PRIM_TYPE
  CompoundDoubleDataset | Extend compound dataset for double values // PRIM_TYPE
  CompoundFloatDataset | Extend compound dataset for float values // PRIM_TYPE
  CompoundIntegerDataset | Extend compound dataset for int values // PRIM_TYPE
  CompoundLongDataset | Extend compound dataset for long values // PRIM_TYPE
  CompoundShortDataset | Extend compound dataset for short values // PRIM_TYPE
  ContiguousIterator | Class to run over contiguous datasets
  ContiguousIteratorWithPosition | Class to run over contiguous datasets and keep track of position.
  ContiguousPairIterator | Class to run over a pair of contiguous datasets
  ContiguousSingleIterator | Class to run over a pair of contiguous datasets with only the second dataset read
  DataEvent | Event fired to diseminate information about a dataset changing.
  DataListenerDelegate | Class used by DynamicDataset to delegate
  DatasetFactory |
  DatasetUtils | Utilities for manipulating datasets
  DateDatasetImpl |
  DoubleDataset | Extend dataset for double values // PRIM_TYPE
  DTypeUtils |
  FloatDataset | Extend dataset for float values // PRIM_TYPE
  IndexIterator | Class to provide iteration through whole data array that backs a dataset
  IntegerDataset | Extend dataset for int values // PRIM_TYPE
  IntegerIterator | Class to run over an integer dataset and return its items
  IntegersIterator | Class to run over an array of integer datasets and return its items
  InterpolatorUtils |
  LazyDataset |
  LazyDatasetBase | Common base for both lazy and normal dataset implementations
  LazyDynamicDataset |
  LazyMaths | Mathematics class for lazy datasets
  LazyWriteableDataset | Subclass of lazy dataset that allows setting slices
  LinearAlgebra |
  LongDataset | Extend dataset for long values // PRIM_TYPE
  Maths | Mathematics class
  NullIterator |
  ObjectDataset | Extend dataset for objects
  ObjectDatasetBase | Extend dataset for Object values // PRIM_TYPE
  Operations |
  Operations.Addition | Addition with boolean or
  Operations.Division | Division with boolean and of negated second operand
  Operations.DivisionTowardsFloor | Division with boolean and of negated second operand and rounds down to negative infinity
  Operations.DivisionWithZero | Division with boolean and of negated second operand and returns zero if denominator is zero
  Operations.Exponentiation | Exponentiation with boolean and
  Operations.Maximum | Select maximum of a and b
  Operations.Minimum | Select minimum of a and b
  Operations.Multiplication | Multiplication with boolean and
  Operations.Negation | Negation with boolean not
  Operations.Remainder | Remainder
  Operations.Subtraction | Subtraction with boolean or of negated second operand
  Operations.UseBase | Use given value if a > b else use a
  Operations.UseIfEqualTo | Use given value if a == b else use a
  Operations.UseIfGreaterThan | Use given value if a > b else use a
  Operations.UseIfGreaterThanOrEqualTo | Use given value if a >= b else use a
  Operations.UseIfLessThan | Use given value if a < b else use a
  Operations.UseIfLessThanOrEqualTo | Use given value if a <= b else use a
  Outliers | Estimators of the scale of a Dataset.
  PositionIterator | Class to provide iteration through a dataset
  Random | Class to hold methods to create random datasets Emulates numpy.random
  RGBDataset | Class to hold colour datasets as red, green, blue tuples of short integers
  RunningAverage | A running mean class
  ShapeChangeChecker | Checks whether shape has changed between waits.
  ShapeUtils |
  ShortDataset | Extend dataset for short values // PRIM_TYPE
  SingleInputBroadcastIterator | Class to run over a single dataset with NumPy broadcasting to promote shapes which have lower rank and outputs to a second dataset
  SingleItemIterator | Class to run over a broadcasted single-item dataset
  Slice | The `Slice` class represents the set of indices (start, stop, step), that are used to extract specifics subsets of `Dataset`. The start argument default to 0, stop argument default to the stop argument default to the end of the dimension that the slice is applied to, and the default argument for the step is 1.
  SliceIterator | The `SliceIterator` class is use to run over a Slice of a Dataset.
  SliceND | The `SliceND` class represents a slice through all dimensions of a multi-dimensional `Dataset`. A slice comprises a starting position array, a stopping position array (not included) and a stepping size array. If a maximum shape is specified, slicing past the original shape is supported for positive steps otherwise it is ignored.
  SliceNDIterator | Class to provide slice iteration through a dataset
  Stats | Statistics class TODO Where is mode? http://en.wikipedia.org/wiki/Mode_(statistics)
  StrideIterator | Class to run over a contiguous dataset using strides
  StringDataset | Extend dataset for objects
  StringDatasetBase | Extend dataset for String values // PRIM_TYPE
  UnaryOperation.Stub | Stub class where only two methods need to be overridden: `UnaryOperation.Stub.complexOperate(double[], double, double)`, `UnaryOperation.Stub.toString(String)`

- Enum Summary
  Enum | Description
  --- | ---
  Comparisons.Monotonicity | Enumeration of monotonicity.
  LinearAlgebra.NormOrder | Order value for norm

Copyright © 2014–2018 Eclipse Foundation. All rights reserved.