Changeset 34255 in project


Ignore:
Timestamp:
08/06/17 16:45:57 (4 months ago)
Author:
sjamaan
Message:

man/5: Move srfi-4 from TODO to Module srfi-4, as it is not going to change (and finished). Add link between it and the blob module to clarify the relation

Location:
wiki/man/5
Files:
5 edited
1 moved

Legend:

Unmodified
Added
Removed
  • wiki/man/5/Included modules

    r34254 r34255  
    1212* [[Module r5rs]] : Standard Scheme procedures and syntax (alias for scheme)
    1313* [[Module r4rs]] : Standard procedures and syntax of an old Scheme report
     14* [[Module srfi-4]] : Homogeneous numeric vector datatypes
    1415* [[Module (chicken bitwise)]] : Bitwise manipulation on integers
    1516* [[Module (chicken blob)]] : Unstructured byte data
  • wiki/man/5/Module (chicken bitwise)

    r34254 r34255  
    3434
    3535---
    36 Previous: [[Module r4rs]]
     36Previous: [[Module srfi-4]]
    3737
    3838Next: [[Module (chicken blob)]]
  • wiki/man/5/Module (chicken blob)

    r34254 r34255  
    66This module contains procedures for dealing with "blobs".  Blobs are
    77unstructured byte arrays (basically "binary strings"). You can't do
    8 much with them, but they allow conversion to and from SRFI-4 number
    9 vectors which define how to access a blob's byte contents.
     8much with them, but they allow conversion to and from
     9[[Module srfi-4|SRFI-4 number vectors]] which define how to access a
     10blob's byte contents.
    1011
    1112=== make-blob
  • wiki/man/5/Module r4rs

    r34052 r34255  
    1313Previous: [[Module r5rs]]
    1414
    15 Next: [[Module (chicken bitwise)]]
     15Next: [[Module srfi-4]]
  • wiki/man/5/Module srfi-4

    r34254 r34255  
    11[[tags: manual]]
    2 
    3 == Unit srfi-4
    4 
    5 Homogeneous numeric vector datatypes.  Also see the [[http://srfi.schemers.org/srfi-4/srfi-4.html|original SRFI-4 document]].
    6 
    72[[toc:]]
    83
    9 == CHICKEN implementation
    10 
    11 * Procedures for blob conversion, subvectors and vector I/O are provided.
     4== Module srfi-4
     5
     6Homogeneous numeric vector datatypes.  Also see the
     7[[http://srfi.schemers.org/srfi-4/srfi-4.html|original SRFI-4 document]].
     8
     9=== CHICKEN implementation specifics and extensions
     10
     11* Procedures for [[Module (chicken blob)|blob]] conversion, subvectors and vector I/O are provided.
    1212* SRFI-17 setters for {{XXXvector-ref}} are defined.
    1313* Constructors allow allocating the storage in non garbage collected memory.
    1414
    1515=== Blob conversions
     16
     17As a SRFI-4 vector is basically just a [[Module (chicken blob)|blob]]
     18wrapped by a SRFI-4 type "header object" to structure its contents,
     19there are several procedures which can convert between blobs and
     20SRFI-4 vectors.
    1621
    1722<procedure>(u8vector->blob U8VECTOR)</procedure><br>
     
    3843Each of these procedures return the contents of the given vector as a
    3944'packed' blob. The byte order in that vector is platform-dependent
    40 (for example little-endian on an '''Intel''' processor). The {{/shared}}
    41 variants return a blob that shares memory with the contents of the vector.
     45(for example little-endian on an '''Intel''' processor). The
     46{{/shared}} variants return a blob that shares memory with the
     47contents of the vector, the others will copy the contents of the
     48SRFI-4 vector's internal blob object.
    4249
    4350<procedure>(blob->u8vector BLOB)</procedure><br>
     
    6269<procedure>(blob->f64vector/shared BLOB)</procedure><br>
    6370
    64 Each of these procedures return a vector where the argument
    65 {{BLOB}} is taken as a 'packed' representation of the contents
    66 of the vector. The {{/shared}} variants return a vector that
    67 shares memory with the contents of the blob.
     71Each of these procedures return a vector where the argument {{BLOB}}
     72is taken as a 'packed' representation of the contents of the
     73vector. The {{/shared}} variants return a vector that shares memory
     74with the contents of the blob, the others will copy the blob.
    6875
    6976=== Subvectors
     
    8087<procedure>(subf64vector F64VECTOR FROM TO)</procedure><br>
    8188
    82 Creates a number vector of the same type as the argument vector with the elements at the positions {{FROM}} up to but
    83 not including {{TO}}.
     89Creates a fresh number vector of the same type as the argument vector
     90with the elements at the positions {{FROM}} up to but not including
     91{{TO}}.
    8492
    8593=== Vector I/O
     
    351359
    352360---
    353 Previous: [[Unit extras]]
    354 
    355 Next: [[Unit posix]]
     361Previous: [[Module r4rs]]
     362
     363Next: [[Unit (chicken bitwise)]]
  • wiki/man/5/TODO/new-manual.org

    r34254 r34255  
    1212** Module r5rs : Standard Scheme procedures and syntax (alias for scheme)
    1313** Module r4rs : Standard procedures and syntax of an old Scheme report
     14** Module srfi-4 : Homogeneous numeric vector datatypes
    1415** Module (chicken bitwise) : Bitwise manipulation on integers
    1516** Module (chicken blob) : Unstructured byte data
Note: See TracChangeset for help on using the changeset viewer.