Skip to main content

read

Method of HDF5Group.

Overloads​

NameDescription
read(const string path, as_string type) -> ObjectReads a string scalar dataset relative to the group.
read(const string path, as_string | as_list type) -> ListReads a string list dataset relative to the group.
read(const string path, as_integer type) -> ObjectReads a integer scalar dataset relative to the group.
read(const string path, as_real type) -> ObjectReads a real scalar dataset relative to the group.
read(const string path, as_complex type) -> ObjectReads a complex scalar dataset relative to the group.
read(const string path, as_real | as_tensor type) -> RealTensorReads a real tensor dataset relative to the group.
read(const string path, as_bool | as_array type) -> BoolArrayReads a bool array dataset relative to the group.
read(const string path, as_integer | as_array type) -> IntegerArrayReads a integer array dataset relative to the group.
read(const string path, as_real | as_array type) -> RealArrayReads a real array dataset relative to the group.
read(const string path, as_complex | as_array type) -> ComplexArrayReads a complex array dataset relative to the group.
read(const string path, as_real | as_matrix type) -> RealMatrixReads a real matrix dataset relative to the group.
read(const string path, as_complex | as_list type) -> ListReads a complex list dataset relative to the group.
read(const string path, as_bool type) -> ObjectReads a bool scalar dataset relative to the group.
read(const string path, as_real | as_list type) -> ListReads a real list dataset relative to the group.
read(const string path, as_integer | as_list type) -> ListReads a integer list dataset relative to the group.
read(const string path, as_bool | as_list type) -> ListReads a bool list dataset relative to the group.
read(const string path, as_complex | as_tensor type) -> ComplexTensorReads a complex tensor dataset relative to the group.
read(const string path, as_complex | as_sparsematrix type) -> ComplexSparseMatrixReads a complex sparse matrix dataset relative to the group.
read(const string path, as_complex | as_matrix type) -> ComplexMatrixReads a complex matrix dataset relative to the group.
read(const string path, as_real | as_sparsematrix type) -> RealSparseMatrixReads a real sparse matrix dataset relative to the group.

read(const string path, as_string type) -> Object​

Reads a string scalar dataset relative to the group.

Parameters​

  • path: Relative dataset path.
  • type: Type tag (as_string).

Example​

var g = HDF5File("data.h5").open_group("/runs")
var value = g.read("run1/answer", as_string)

read(const string path, as_string | as_list type) -> List​

Reads a string list dataset relative to the group.

Parameters​

  • path: Relative dataset path.
  • type: Type tag (as_string | as_list).

Example​

var g = HDF5File("data.h5").open_group("/runs")
var values = g.read("run1/values", as_string | as_list)

read(const string path, as_integer type) -> Object​

Reads a integer scalar dataset relative to the group.

Parameters​

  • path: Relative dataset path.
  • type: Type tag (as_integer).

Example​

var g = HDF5File("data.h5").open_group("/runs")
var value = g.read("run1/answer", as_integer)

read(const string path, as_real type) -> Object​

Reads a real scalar dataset relative to the group.

Parameters​

  • path: Relative dataset path.
  • type: Type tag (as_real).

Example​

var g = HDF5File("data.h5").open_group("/runs")
var value = g.read("run1/answer", as_real)

read(const string path, as_complex type) -> Object​

Reads a complex scalar dataset relative to the group.

Parameters​

  • path: Relative dataset path.
  • type: Type tag (as_complex).

Example​

var g = HDF5File("data.h5").open_group("/runs")
var value = g.read("run1/answer", as_complex)

read(const string path, as_real | as_tensor type) -> RealTensor​

Reads a real tensor dataset relative to the group.

Parameters​

  • path: Relative dataset path.
  • type: Type tag (as_tensor | as_real).

read(const string path, as_bool | as_array type) -> BoolArray​

Reads a bool array dataset relative to the group.

Parameters​

  • path: Relative dataset path.
  • type: Type tag (as_array | as_bool).

read(const string path, as_integer | as_array type) -> IntegerArray​

Reads a integer array dataset relative to the group.

Parameters​

  • path: Relative dataset path.
  • type: Type tag (as_array | as_integer).

read(const string path, as_real | as_array type) -> RealArray​

Reads a real array dataset relative to the group.

Parameters​

  • path: Relative dataset path.
  • type: Type tag (as_array | as_real).

read(const string path, as_complex | as_array type) -> ComplexArray​

Reads a complex array dataset relative to the group.

Parameters​

  • path: Relative dataset path.
  • type: Type tag (as_array | as_complex).

read(const string path, as_real | as_matrix type) -> RealMatrix​

Reads a real matrix dataset relative to the group.

Parameters​

  • path: Relative dataset path.
  • type: Type tag (as_matrix | as_real).

read(const string path, as_complex | as_list type) -> List​

Reads a complex list dataset relative to the group.

Parameters​

  • path: Relative dataset path.
  • type: Type tag (as_complex | as_list).

Example​

var g = HDF5File("data.h5").open_group("/runs")
var values = g.read("run1/values", as_complex | as_list)

read(const string path, as_bool type) -> Object​

Reads a bool scalar dataset relative to the group.

Parameters​

  • path: Relative dataset path.
  • type: Type tag (as_bool).

Example​

var g = HDF5File("data.h5").open_group("/runs")
var value = g.read("run1/answer", as_bool)

read(const string path, as_real | as_list type) -> List​

Reads a real list dataset relative to the group.

Parameters​

  • path: Relative dataset path.
  • type: Type tag (as_real | as_list).

Example​

var g = HDF5File("data.h5").open_group("/runs")
var values = g.read("run1/values", as_real | as_list)

read(const string path, as_integer | as_list type) -> List​

Reads a integer list dataset relative to the group.

Parameters​

  • path: Relative dataset path.
  • type: Type tag (as_integer | as_list).

Example​

var g = HDF5File("data.h5").open_group("/runs")
var values = g.read("run1/values", as_integer | as_list)

read(const string path, as_bool | as_list type) -> List​

Reads a bool list dataset relative to the group.

Parameters​

  • path: Relative dataset path.
  • type: Type tag (as_bool | as_list).

Example​

var g = HDF5File("data.h5").open_group("/runs")
var values = g.read("run1/values", as_bool | as_list)

read(const string path, as_complex | as_tensor type) -> ComplexTensor​

Reads a complex tensor dataset relative to the group.

Parameters​

  • path: Relative dataset path.
  • type: Type tag (as_tensor | as_complex).

read(const string path, as_complex | as_sparsematrix type) -> ComplexSparseMatrix​

Reads a complex sparse matrix dataset relative to the group.

Parameters​

  • path: Relative dataset path.
  • type: Type tag (as_sparsematrix | as_complex).

read(const string path, as_complex | as_matrix type) -> ComplexMatrix​

Reads a complex matrix dataset relative to the group.

Parameters​

  • path: Relative dataset path.
  • type: Type tag (as_matrix | as_complex).

read(const string path, as_real | as_sparsematrix type) -> RealSparseMatrix​

Reads a real sparse matrix dataset relative to the group.

Parameters​

  • path: Relative dataset path.
  • type: Type tag (as_sparsematrix | as_real).