Function

Summary

Calls a function on each element of a ring, modifying the element.

Package

hcl

Signature

map-ring ring function

Arguments

ring

A ring object created by make-ring.

function

A function designator for a function of one argument.

Description

The function map-ring funcalls the function function on each element in the ring in turn, and sets that ring element to the result.

Notes

1. function is called with the ring locked.
2. If you do not intend to modify the elements of ring, ensure that function returns its argument.

See also

make-ring
position-in-ring
position-in-ring-forward