WordArray.st
author Claus Gittinger <cg@exept.de>
Tue, 26 Feb 2008 11:29:14 +0100
changeset 1930 935b2870be2e
parent 1414 e801d1248f10
child 2645 1950f0398db0
permissions -rw-r--r--
arrow points reusable (class protocol)

"{ Encoding: iso8859-1 }"

"
 COPYRIGHT (c) 1989 by Claus Gittinger
	      All Rights Reserved

 This software is furnished under a license and may be used
 only in accordance with the terms of that license and with the
 inclusion of the above copyright notice.   This software may not
 be provided or otherwise made available to, or used by, any
 other person.  No title to or ownership of the software is
 hereby transferred.
"

"{ Package: 'stx:libbasic2' }"

UnboxedIntegerArray variableWordSubclass:#WordArray
	instanceVariableNames:''
	classVariableNames:''
	poolDictionaries:''
	category:'Collections-Arrayed'
!

!WordArray class methodsFor:'documentation'!

copyright
"
 COPYRIGHT (c) 1989 by Claus Gittinger
	      All Rights Reserved

 This software is furnished under a license and may be used
 only in accordance with the terms of that license and with the
 inclusion of the above copyright notice.   This software may not
 be provided or otherwise made available to, or used by, any
 other person.  No title to or ownership of the software is
 hereby transferred.
"
!

documentation
"
    WordArrays store integers in the range 0..16rFFFF.
    In contrast to normal arrays (which store pointers to their elements),
    wordArrays store the values in a dense & compact way. 
    Since the representation fits the underlying C-language systems representation
    of unsigned int16's, this is also useful to pass bulk data to c primitive code.

    WordArrays can be used to hold bulk integer data in a more compact way.
        For example:
            Array new:100000 withAll:1
        requires 400k of object memory;

        in contrast,
            WordArray new:100000 withAll:1
        only requires half of it.

    [memory requirements:]
        OBJ-HEADER + (size * 2)

    [see also:]
        ByteArray BooleanArray FloatArray DoubleArray Array
        SignedWordArray

    [author:]
        Claus Gittinger
"
! !

!WordArray class methodsFor:'documentation'!

version
    ^ '$Header: /cvs/stx/stx/libbasic2/WordArray.st,v 1.6 2004-03-03 20:49:21 cg Exp $'
! !