# Module bench

- Description
- Data Types
- Function Index
- Function Details

This is a small server for running benchmarks.

Copyright © 2007-2015 Zuse Institute Berlin

Version: $Id$

Authors: Thorsten Schuett (`schuett@zib.de`).

## Description

This is a small server for running benchmarks

## Data Types

### client_key()

    client_key() = [unicode_char()]

### options()

    options() =
        [locally |
         print |
         verbose |
         profile |
         {copies, non_neg_integer()}]

### unicode_char()

    unicode_char() = 0..55295 | 57344..65533 | 65536..1114111

## Function Index

increment/2 | run an increment benchmark (i++) on all nodes.
increment/3 | run an increment benchmark on all nodes (with a user-specified key).
increment_o/3 | run an increment benchmark (i++) on all nodes with custom options.
increment_o/4 | run an increment benchmark on all nodes (with a user-specified key) with custom options.
increment_with_histo/2 | run an increment benchmark (i++) on all nodes.
increment_with_histo_o/3 | run an increment benchmark (i++) on all nodes with custom options.
load_start/1 |
load_stop/0 |
quorum_read/2 | run an read benchmark on all nodes.
quorum_read_o/3 | run an read benchmark on all nodes with custom options.
read_read/2 | run an read benchmark on all nodes.
read_read_o/3 | run an read benchmark on all nodes with custom options.

## Function Details

### increment/2

    increment(ThreadsPerVM :: pos_integer(),
              Iterations :: pos_integer()) ->
                 {ok, [{atom(), term()}, ...]}

run an increment benchmark (i++) on all nodes

### increment_o/3

    increment_o(ThreadsPerVM :: pos_integer(),
                Iterations :: pos_integer(),
                Options :: options()) ->
                   {ok, [{atom(), term()}, ...]}

run an increment benchmark (i++) on all nodes with custom options

### increment_with_histo/2

    increment_with_histo(ThreadsPerVM :: pos_integer(),
                         Iterations :: pos_integer()) ->
                            {ok, [{atom(), term()}, ...]}

run an increment benchmark (i++) on all nodes

### increment_with_histo_o/3

    increment_with_histo_o(ThreadsPerVM :: pos_integer(),
                           Iterations :: pos_integer(),
                           Options :: options()) ->
                              {ok, [{atom(), term()}, ...]}

run an increment benchmark (i++) on all nodes with custom options

### increment/3

    increment(ThreadsPerVM :: pos_integer(),
              Iterations :: pos_integer(),
              Key :: client_key()) ->
                 {ok, [{atom(), term()}, ...]} |
                 {failed, init_per_key}

run an increment benchmark on all nodes (with a user-specified key)

### increment_o/4

    increment_o(ThreadsPerVM :: pos_integer(),
                Iterations :: pos_integer(),
                Key :: client_key(),
                Options :: options()) ->
                   {ok, [{atom(), term()}, ...]} |
                   {failed, init_per_key}

run an increment benchmark on all nodes (with a user-specified key) with custom options

### quorum_read/2

    quorum_read(ThreadsPerVM :: pos_integer(),
                Iterations :: pos_integer()) ->
                   {ok, [{atom(), term()}, ...]}

run an read benchmark on all nodes

### quorum_read_o/3

    quorum_read_o(ThreadsPerVM :: pos_integer(),
                  Iterations :: pos_integer(),
                  Options :: options()) ->
                     {ok, [{atom(), term()}, ...]}

run an read benchmark on all nodes with custom options

### read_read/2

    read_read(ThreadsPerVM :: pos_integer(),
              Iterations :: pos_integer()) ->
                 {ok, [{atom(), term()}, ...]}

run an read benchmark on all nodes

### read_read_o/3

    read_read_o(ThreadsPerVM :: pos_integer(),
                Iterations :: pos_integer(),
                Options :: options()) ->
                   {ok, [{atom(), term()}, ...]}

run an read benchmark on all nodes with custom options

### load_start/1

    load_start(Gap :: pos_integer()) -> ok

### load_stop/0

    load_stop() -> ok

Generated by EDoc, Feb 29 2016, 16:12:22.