gonumberio

README

Go array reader

Generic library for reading 1D, 2D and 3D arrays from a text file.

Documentation

Index

• Constants
• func ConvertBool(r *ByteReader) (bool, uint, error)
• func ConvertByte(r *ByteReader) (byte, uint, error)
• func ConvertFloat[T constraints.Float](r *ByteReader) (T, uint, error)
• func ConvertSigned[T constraints.Signed](r *ByteReader) (T, uint, error)
• func ConvertUnsigned[T constraints.Unsigned](r *ByteReader) (T, uint, error)
• func GetConversion[T any]() func(r *ByteReader) (T, uint, error)
• func Read[T any](reader io.Reader) (T, error)
• func Read1D[T any](r io.Reader) ([]T, error)
• func Read1DCustom[T any](r io.Reader, chunkSize int, conv func(*ByteReader) (T, uint, error)) ([]T, error)
• func Read2D[T any](r io.Reader) ([][]T, error)
• func Read2DCustom[T any](r io.Reader, chunkSize int, conv func(*ByteReader) (T, uint, error)) ([][]T, error)
• func Read3D[T any](r io.Reader) ([][][]T, error)
• func Read3DCustom[T any](r io.Reader, chunkSize int, conv func(*ByteReader) (T, uint, error)) ([][][]T, error)
• func ReadCustom[T any](reader io.Reader, chunkSize int) (T, error)
• type ByteReader

Constants

const (
	DefaultChunkSize int = 32768
)

Functions

func ConvertBool

func ConvertBool(r *ByteReader) (bool, uint, error)

func ConvertByte

func ConvertByte(r *ByteReader) (byte, uint, error)

func ConvertFloat

func ConvertFloat[T constraints.Float](r *ByteReader) (T, uint, error)

func ConvertSigned

func ConvertSigned[T constraints.Signed](r *ByteReader) (T, uint, error)

func ConvertUnsigned

func ConvertUnsigned[T constraints.Unsigned](r *ByteReader) (T, uint, error)

func GetConversion

func GetConversion[T any]() func(r *ByteReader) (T, uint, error)

func Read

func Read[T any](reader io.Reader) (T, error)

func Read1D

func Read1D[T any](r io.Reader) ([]T, error)

func Read1DCustom

func Read1DCustom[T any](
	r io.Reader, chunkSize int, conv func(*ByteReader) (T, uint, error)) ([]T, error)

func Read2D

func Read2D[T any](r io.Reader) ([][]T, error)

func Read2DCustom

func Read2DCustom[T any](
	r io.Reader, chunkSize int, conv func(*ByteReader) (T, uint, error)) ([][]T, error)

func Read3D

func Read3D[T any](r io.Reader) ([][][]T, error)

func Read3DCustom

func Read3DCustom[T any](
	r io.Reader, chunkSize int, conv func(*ByteReader) (T, uint, error)) ([][][]T, error)

func ReadCustom

func ReadCustom[T any](
	reader io.Reader, chunkSize int) (T, error)

Types

type ByteReader

type ByteReader = ite.ByteReader