bug-guile
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: more garbled documentation in uniform arrays


From: Rouben Rostamian
Subject: Re: more garbled documentation in uniform arrays
Date: Sat, 17 Jan 2004 10:48:08 -0500

Kevin Ryde <address@hidden> wrote:

> "Rouben Rostamian" <address@hidden> writes:
> >
> > Essentially all items listed in this section need a good overhaul.
> 
> Yep.  Bit of polish below.  The hairy functions like enclose-array are
> still not super clear.
> 
> Conventional Arrays
> -------------------
> 
> "Conventional arrays" are a collection of cells organized into an
> arbitrary number of dimensions.  Each cell can hold any kind of Scheme
...snipped...

Thanks, Kevin, for doing all that work in cleaning up the manual
section on Conventional Arrays.  I think it makes much better sense
now.  The addition of sample code fragments in several places is a
very good touch.

I have a couple of suggestions for further changes.

1.
The subject of this section is "Conventional Arrays".  Mixing in
the documentation of uniform-arrays/uniform-vectors is not ideal.
I think it would be less confusing if the descriptions of all
uniform-* procedures were moved to the section "Uniform Arrays"
where they belong.

2.
The second paragraph in the description of make-array reads a bit
awkward to me.  I have suggested an alternative below.  Use it if
you see fit.

--------------------
 - Scheme Procedure: make-array initial-value bound ...
     Create and return an array that has as many dimensions as there are
     BOUNDs and fill it with INITIAL-VALUE.

old  Each BOUND may be a positive non-zero integer N, in which case the
old  index for that dimension can range from 0 through N-1; or an
old  explicit index range specifier in the form `(LOWER UPPER)', where
old  both LOWER and UPPER are integers, possibly less than zero, and
old  possibly the same number (however, LOWER cannot be greater than
old  UPPER).

new  Each BOUND may be a positive non-zero integer N, in which case
new  the index for that dimension can range from 0 through N-1;
new  or an explicit index range specifier as a list of two integers
new  `(LOWER UPPER)', where LOWER or UPPER may be negative but
new  UPPER cannot be less than LOWER.


-- 
Rouben Rostamian




reply via email to

[Prev in Thread] Current Thread [Next in Thread]