\input texinfo @c -*- texinfo -*-

@c Generated by eggdoc-texinfo $Revision$ (c) 2006 Jim Ursetto

@c %**start of header

@setfilename vector-lib.egg.info

@settitle vector-lib egg: Reference implementation of @url{http://srfi.schemers.org/srfi-43, SRFI-43: Vector library}

@c %**end of header

@finalout 

@dircategory The Algorithmic Language Scheme
@direntry
* vector-lib.egg: (vector-lib.egg).		Reference implementation of SRFI-43: Vector library
@end direntry


@titlepage 

@title vector-lib egg

@subtitle Reference implementation of @url{http://srfi.schemers.org/srfi-43, SRFI-43: Vector library}

@subtitle Extension for Chicken Scheme

@subtitle Version 1.1

@author Taylor Campbell; port by @url{http://3e8.org/zb, Zbigniew}

@end titlepage
@contents 

@syncodeindex vr fn


@ifnottex 

@node Top
@top vector-lib egg


Reference implementation of @url{http://srfi.schemers.org/srfi-43, SRFI-43: Vector library}


@noindent 
Written by Taylor Campbell; port by @url{http://3e8.org/zb, Zbigniew}

This manual corresponds to version 1.1 of the vector-lib extension library for Chicken Scheme.

@menu 
* About this egg::
* Documentation::
* License::
* Index::

@end menu

@end ifnottex
@node About this egg
@chapter About this egg

@menu 
* Version history::
* Usage::

@end menu
@node Version history
@section Version history

@table @code

@item 1.1
Final implementation port by Zbigniew
@item 1.0
Draft implementation port by William S. Annis
@end table


@node Usage
@section Usage

Load this egg like so: 

@code{(require-extension vector-lib)}




@node Documentation
@chapter Documentation

See the @url{http://srfi.schemers.org/srfi-43/srfi-43.html, SRFI-43 document} for full documentation on the reference implementation.

The reference implementation on srfi.schemers.org is buggy
         (as of 24 May 2005).  This code is actually derived from Taylor Campbell's @url{http://srfi.schemers.org/srfi-43/post-mail-archive/msg00001.html, updated version}.

Also included are the following user-visible fixes:

@itemize 

@item @url{http://srfi.schemers.org/srfi-43/post-mail-archive/msg00008.html, vector-map fix} from Will M. Farr

@item @code{list->vector} and @code{reverse-list->vector} obey the @code{START} offset, and disallow negative length

@end itemize

Additionally, @code{list->vector} and @code{reverse-list->vector} accept optional @code{START} and @code{END} arguments: 
@deffn {procedure} {list->vector}


@lisp 
(list->vector LIST [START END])
@end lisp



Produce a vector containing the elements in @code{LIST}, which
must be a proper list, between @code{START}, whose default is 0, and @code{END},
whose default is the length of @code{LIST}.  It is suggested that if the
length of @code{LIST} is known in advance, the @code{START} and @code{END} arguments
be passed, so that @code{list->vector} need not call @code{length} itself.
@end deffn

@deffn {procedure} {reverse-list->vector}


@lisp 
(reverse-list->vector LIST [START END])
@end lisp



Produces the same output as @code{list->vector}, but in reverse order.
@end deffn


This brings them more in line with @code{vector->list} and @code{reverse-vector->list}, which also take @code{START} and @code{END} arguments.


@node License
@chapter License

@verbatim
Copyright (c) 2005, 2006 Jim "Zb" Ursetto.  All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

  Redistributions of source code must retain the above copyright notice,
  this list of conditions and the following disclaimer. Redistributions in
  binary form must reproduce the above copyright notice, this list of
  conditions and the following disclaimer in the documentation and/or
  other materials provided with the distribution. Neither the name of the
  author nor the names of its contributors may be used to endorse or
  promote products derived from this software without specific prior
  written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
@end verbatim



@node Index
@unnumbered Index

@printindex fn


@bye