2.23.4.1 Introduction

In this section containing specifications of procedures, the following notation is used to specify parameters and return values:

(f arg1 arg2 ···) -> something

Indicates a function f takes the parameters arg1, arg2, … and returns a value of the type something. If something is unspecified, then what f returns is implementation–dependant; this SRFI does not specify what it returns, and in order to write portable code, the return value should be ignored.

vec

The argument in this place must be a vector, i.e. it must satisfy the predicate vector?.

i, j, start, size

The argument in this place must be a nonnegative integer, i.e. it must satisfy the predicates integer? and either zero? or positive?. The third case of it indicates the index at which traversal begins; the fourth case of it indicates the size of a vector.

end

The argument in this place must be a positive integer, i.e. it must satisfy the predicates integer? and positive?. This indicates the index directly before which traversal will stop; processing will occur until the the index of the vector is end. It is the closed right side of a range.

f

The argument in this place must be a function of one or more arguments, returning exactly one value.

pred?

The argument in this place must be a function of one or more arguments that returns one value, which is treated as a boolean.

x, y, z, seed, knil, fill, key, value

The argument in this place may be any Scheme value.

[something]

Indicates that something is an optional argument; it needn’t necessarily be applied. Something needn’t necessarily be one thing; for example, this usage of it is perfectly valid:

[start [end]]

and is indeed used quite often.

something ···

Indicates that zero or more somethings are allowed to be arguments.

something1 something2 ···

Indicates that at least one something must be arguments.

something1 something2 ··· somethingn

Exactly equivalent to the previous argument notation, but this also indicates that n will be used later in the procedure description.

It should be noted that all of the procedures that iterate across multiple vectors in parallel stop iterating and produce the final result when the end of the shortest vector is reached. The sole exception is vector=, which automatically returns #f if the vectors’ lengths vary.