API for clojure.data.generators - data.generators 1.1.0-SNAPSHOT (in development)

by Stuart Halloway

Full namespace name: clojure.data.generators

Overview

Data generators for Clojure.

Public Variables and Functions



*rnd*

dynamic var

    
Random instance for use in generators. By consistently using this
instance you can get a repeatable basis for tests.

    
    
    Source
  


anything

function
Usage: (anything)
Returns a scalar or collection based on *rnd*.

    
    
    Source
  


boolean

function
Usage: (boolean)
Returns a bool based on *rnd*.

    
    
    Source
  


boolean-array

function
Usage: (boolean-array f)
       (boolean-array f sizer)
Create an array with elements from f and sized from sizer.

    
    
    Source
  


byte

function
Usage: (byte)
Returns a long based on *rnd* in the byte range.

    
    
    Source
  


byte-array

function
Usage: (byte-array f)
       (byte-array f sizer)
Create an array with elements from f and sized from sizer.

    
    
    Source
  


char

function
Usage: (char)
Returns a character based on *rnd* in the range 0-65536.

    
    
    Source
  


char-array

function
Usage: (char-array f)
       (char-array f sizer)
Create an array with elements from f and sized from sizer.

    
    
    Source
  


collection

function
Usage: (collection)
Returns a collection of scalar elements based on *rnd*.

    
    
    Source
  


date

function
Usage: (date)
       (date base)
Create a date with geometric mean around base which defaults to
#inst "2007-10-16T00:00:00.000-00:00"

    
    
    Source
  


default-sizer

function
Usage: (default-sizer)
Default sizer used to run tests. If you want a specific distribution,
create your own and pass it to a fn that wants a sizer.

    
    
    Source
  


double

function
Usage: (double)
Generate a double between 0 and 1 based on *rnd*.

    
    
    Source
  


double-array

function
Usage: (double-array f)
       (double-array f sizer)
Create an array with elements from f and sized from sizer.

    
    
    Source
  


float

function
Usage: (float)
Generate a float between 0 and 1 based on *rnd*

    
    
    Source
  


float-array

function
Usage: (float-array f)
       (float-array f sizer)
Create an array with elements from f and sized from sizer.

    
    
    Source
  


geometric

function
Usage: (geometric p)
Geometric distribution with mean 1/p.

    
    
    Source
  


hash-map

function
Usage: (hash-map fk fv)
       (hash-map fk fv sizer)
Create a hash-map with keys from fk, vals from fv, and
sized from sizer.

    
    
    Source
  


int

function
Usage: (int)
Returns a int based on *rnd* in the int range.

    
    
    Source
  


int-array

function
Usage: (int-array f)
       (int-array f sizer)
Create an array with elements from f and sized from sizer.

    
    
    Source
  


keyword

function
Usage: (keyword)
       (keyword sizer)
Create a non-namespaced keyword sized from sizer.

    
    
    Source
  


list

function
Usage: (list f)
       (list f sizer)
Create a list with elements from f and sized from sizer.

    
    
    Source
  


long

var

    
Returns a long based on *rnd*. Same as uniform.

    
    
    Source
  


long-array

function
Usage: (long-array f)
       (long-array f sizer)
Create an array with elements from f and sized from sizer.

    
    
    Source
  


one-of

function
Usage: (one-of & specs)
Generates one of the specs passed in, with equal probability.

    
    
    Source
  


printable-ascii-char

function
Usage: (printable-ascii-char)
Returns a char based on *rnd* in the printable ascii range.

    
    
    Source
  


rand-nth

function
Usage: (rand-nth coll)
Replacement of core/rand-nth that allows control of the
randomization basis (through binding *rnd*).

    
    
    Source
  


ratio

function
Usage: (ratio)
       (ratio num-gen denom-gen)
Generate a ratio, with numerator and denominator uniform longs
or as specified

    
    
    Source
  


reps

function
Usage: (reps sizer f)
Returns sizer repetitions of f (or (f) if f is a fn).

    
    
    Source
  


reservoir-sample

function
Usage: (reservoir-sample ct coll)
Reservoir sample ct items from coll, using *rnd*.

    
    
    Source
  


scalar

function
Usage: (scalar)
Returns a scalar based on *rnd*.

    
    
    Source
  


set

function
Usage: (set f)
       (set f sizer)
Create a set with elements from f and sized from sizer.

    
    
    Source
  


short

function
Usage: (short)
Returns a short based on *rnd* in the short range.

    
    
    Source
  


short-array

function
Usage: (short-array f)
       (short-array f sizer)
Create an array with elements from f and sized from sizer.

    
    
    Source
  


shuffle

function
Usage: (shuffle coll)
Shuffle coll based on *rnd*

    
    
    Source
  


string

function
Usage: (string)
       (string f)
       (string f sizer)
Create a string with chars from f and sized from sizer.

    
    
    Source
  


symbol

function
Usage: (symbol)
       (symbol sizer)
Create a non-namespaced symbol sized from sizer.

    
    
    Source
  


tuple

function
Usage: (tuple & generators)
Generate a tuple with one element from each generator.

    
    
    Source
  


uniform

function
Usage: (uniform)
       (uniform lo hi)
Uniform distribution from lo (inclusive) to hi (exclusive).
Defaults to range of Java long.

    
    
    Source
  


uuid

function
Usage: (uuid)
Create a UUID based on uniform distribution of low and high parts.

    
    
    Source
  


vec

function
Usage: (vec f)
       (vec f sizer)
Create a vec with elements from f and sized from sizer.

    
    
    Source
  


weighted

function
Usage: (weighted m)
Given a map of generators and weights, return a value from one of
the generators, selecting generator based on weights.

    
    
    Source
  
Logo & site design by Tom Hickey.
Clojure auto-documentation system by Tom Faulhaber.