Counter

8.16.0.1

Counter🔗ℹ

Maciej Barć <xgqt@riseup.net>

1 About

1 About🔗ℹ

1.1 The library🔗ℹ

(require counter)

package: counter

counter is a very simple OOP-like library providing two functions for creating simple "counter" closures: make-meter & make-counter.

Those functions can be utilized for logging, for debugging output of console applications or just counting iteration times of some other functions.

The core library is written in pure scheme and can be utilized by probably most scheme implamentations.

Know limitations are that the counter can only count up. To have a more freeform way use structs, objects, make-parameter or just utilize set!.

1.2 Upstream🔗ℹ

The upstream repository can be found on GitLab.

1.3 License🔗ℹ

Counter is available in Public Domain or under the CC0 License.

2 Alternative🔗ℹ

As described previously a simple set! can be used to manage "counters" in a similar fashion.

Examples:

> (define c 0)
> (set! c (+ c 1))
> c
1
> (set! c (+ c 1))
> c
2

Examples:

> (define count!
    (let ([c 0])
      (lambda () (set! c (+ c 1))
        c)))
> (count!)
1
> (count!)
2

With counter similar code would look like:

Examples:

> (define c (make-counter 0))
> (c 'run)
1
> (c 'get 'val)
1
> (c 'runs 1)
2
> (c 'runs 0)
2

Benefits of using make-counter over set! are less code (which is also more DRY). Also the number of times the growth-procedure is ran can be specified. If the number of runs is zero or less only the value of the counter is returned.

3 Exported functions🔗ℹ

procedure
(make-meter init-val
init-growth-procedure
init-interval) → procedure?
  init-val : number?
  init-growth-procedure : procedure?
  init-interval : number?

Returns a new closure function which when called with ’run will execute growth-procedure on val (initially val = init-val) and interval replacing val with new value and, then return that new value.

Example: starting value is 1 and then it is multipled by 2 on each call.

(define m (make-meter 1 * 2))

procedure
(make-counter start) → procedure?
start : number?

Uses make-meter to create a function which uses + as growth-procedure and has interval equal to 1.

Example: starting value is 0 and then it is increased by 1 on each call.

(define c (make-counter 0))

4 Examples🔗ℹ

Make an new counter c

(define c (make-counter 0))

Check type of c

Examples:

> (define c (make-counter 0))
> (procedure? c)
#t

Check type of (c 'run)

Examples:

> (define c (make-counter 0))
> (procedure? (c 'run))
#f

Execute (c 'run) function

Examples:

> (define c (make-counter 0))
> (c 'run)
1

Execute (c 'runs) function two times

Examples:

> (define c (make-counter 0))
> (c 'runs 2)
2

To execute (c 'run) any argument may be passed to c

Examples:

> (define c (make-counter 0))
> (c #t)
1

Some more OOP - set the value inside c closure to 99

(c 'set 'val 99)

And check the value

Examples:

> (define c (make-counter 0))
> (c 'set 'val 99)
> (c 'get 'val)
99

Also check out tests.rkt included in this project.