[ Tcllib Home | Main Table Of Contents | Table Of Contents | Keyword Index | Categories | Modules | Applications ]

# bench::in(n) 0.1 tcllib "Benchmarking/Performance tools"

## Name

bench::in - bench::in - Reading benchmark results

## Synopsis

- package require Tcl 8.2
- package require csv
- package require bench::in ?0.1?

- ::bench::in::read file

## Description

This package provides a command for reading benchmark results from files, sockets, etc.

A reader interested in the creation, processing or writing of such results should go and read bench - Processing benchmark suites instead.

If the bench language itself is the actual interest please start with the bench language introduction and then proceed from there to the formal bench language specification.

## PUBLIC API

::bench::in::read file

  This command reads a benchmark result from the specified file and returns it as its result. The command understands the three formats created by the commands

  bench::out::raw

    Provided by package bench.

  bench::out::csv

    Provided by package bench::out::csv.

  bench::out::text

    Provided by package bench::out::text.

  and automatically detects which format is used by the input file.

## Bugs, Ideas, Feedback

This document, and the package it describes, will undoubtedly contain bugs and other problems. Please report such in the category bench of the Tcllib Trackers. Please also report any ideas for enhancements you may have for either package and/or documentation.

When proposing code changes, please provide unified diffs, i.e the output of diff -u.

Note further that attachments are strongly preferred over inlined patches. Attachments can be made by going to the Edit form of the ticket immediately after its creation, and then using the left-most button in the secondary navigation bar.

## See Also

bench, bench::out::csv, bench::out::text, bench_intro

## Keywords

benchmark, csv, formatting, human readable, parsing, performance, reading, testing, text

## Category

Benchmark tools

## Copyright

Copyright © 2007 Andreas Kupries <andreas_kupries@users.sourceforge.net>