From 524d4c9b225f185c90392f206992ea7e53cb4f1c Mon Sep 17 00:00:00 2001 From: Paul Duncan Date: Tue, 5 Feb 2019 16:37:11 -0500 Subject: README.md: improve "Data File" section, add more benchmarks --- README.md | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 4554d22..ea107cd 100644 --- a/README.md +++ b/README.md @@ -55,17 +55,18 @@ Data File Format Reads and writes newline-delimited plain text files in the following format: -* Lines are delimited by newlines -* Each line is a record. -* Record fields are delimited by whitespace. -* The first row specifies the *shape* of the remaining rows as two - unsigned integers. The first unsigned integer -- `num_floats` -- - indicates the number of floating point columns per row, and the second - unsigned integer -- `num_ints` -- indicates the number of signed - integer values per row. -* The remaining lines contain data rows. Each row consists of - `num_floats` floating point numbers, followed by `num_ints` signed - integer values. +* Each line is a row. +* Each row consists of one or more columns, delimited by a space. +* Columns are floating point or integer values. +* The first row is called the header row. +* The header row contains two unsigned integer columns which indicate + the layout of the remaining rows. +* The first header row column indicates the number of floating + point columns per row (`num_floats`). +* The second header row column indicates the number of integer + columns per row (`num_ints`). +* The remaining rows contain `num_floats` floating point + columns, followed by `num_ints` signed integer columns. Example data file: -- cgit v1.2.3