SignedWordArray.st
author Stefan Vogel <sv@exept.de>
Tue, 19 Sep 2017 16:40:03 +0200
changeset 22272 ac4a1dcf494c
parent 20649 772b93b7f97a
child 23965 4f380840d33f
permissions -rw-r--r--
#DOCUMENTATION by stefan class: SignedWordArray class comment/format in: #documentation #minVal
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
20649
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     1
"
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     2
 COPYRIGHT (c) 1997 eXept Software AG
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     3
              All Rights Reserved
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     4
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     5
 This software is furnished under a license and may be used
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     6
 only in accordance with the terms of that license and with the
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     7
 inclusion of the above copyright notice.   This software may not
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     8
 be provided or otherwise made available to, or used by, any
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     9
 other person.  No title to or ownership of the software is
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    10
 hereby transferred.
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    11
"
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    12
"{ Package: 'stx:libbasic' }"
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    13
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    14
"{ NameSpace: Smalltalk }"
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    15
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    16
UnboxedIntegerArray variableSignedWordSubclass:#SignedWordArray
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    17
	instanceVariableNames:''
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    18
	classVariableNames:''
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    19
	poolDictionaries:''
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    20
	category:'Collections-Arrayed'
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    21
!
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    22
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    23
!SignedWordArray class methodsFor:'documentation'!
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    24
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    25
copyright
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    26
"
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    27
 COPYRIGHT (c) 1997 eXept Software AG
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    28
              All Rights Reserved
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    29
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    30
 This software is furnished under a license and may be used
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    31
 only in accordance with the terms of that license and with the
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    32
 inclusion of the above copyright notice.   This software may not
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    33
 be provided or otherwise made available to, or used by, any
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    34
 other person.  No title to or ownership of the software is
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    35
 hereby transferred.
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    36
"
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    37
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    38
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    39
!
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    40
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    41
documentation
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    42
"
22272
ac4a1dcf494c #DOCUMENTATION by stefan
Stefan Vogel <sv@exept.de>
parents: 20649
diff changeset
    43
    SignedWordArrays store 16bit signed integers in the range 16r-8000..16r7FFF.
20649
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    44
    They are much like WordArrays, but the values stored are signed.
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    45
    In contrast to normal arrays (which store pointers to their elements),
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    46
    signedWordArrays store the values in a dense & compact way. 
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    47
    Since the representation fits the underlying C-language systems representation
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    48
    of signed int16's, this is also useful to pass bulk data to c primitive code.
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    49
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    50
    Therefore, SignedWordArrays can be used to hold bulk data in a more compact way.
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    51
        For example:
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    52
            Array new:100000 withAll:1
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    53
        requires 400k of object memory;
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    54
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    55
        in contrast,
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    56
            SignedWordArray new:100000 withAll:1
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    57
        only requires half of it.
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    58
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    59
    [memory requirements:]
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    60
        OBJ-HEADER + (size * 2)
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    61
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    62
    [see also:]
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    63
        ByteArray WordArray BooleanArray FloatArray DoubleArray Array
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    64
        IntegerArray LongIntegerArray SignedLongIntegerArray
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    65
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    66
    [author:]
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    67
        Claus Gittinger
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    68
"
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    69
! !
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    70
22272
ac4a1dcf494c #DOCUMENTATION by stefan
Stefan Vogel <sv@exept.de>
parents: 20649
diff changeset
    71
20649
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    72
!SignedWordArray class methodsFor:'queries'!
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    73
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    74
elementByteSize
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    75
    "for bit-like containers, return the number of bytes stored per element.
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    76
     Here, 2 is returned"
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    77
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    78
    ^ 2
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    79
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    80
    "Created: / 15-09-2011 / 14:11:18 / cg"
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    81
!
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    82
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    83
maxVal
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    84
    "the maximum value which can be stored in instances of me.
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    85
     For SignedWordArrays, this is 16r7FFF (largest 16bit signed int)"
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    86
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    87
    ^ 16r7FFF
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    88
!
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    89
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    90
minVal
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    91
    "the minimum value which can be stored in instances of me.
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    92
     For SignedWordArrays, this is -16r8000 (smallest 16bit signed int)"
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    93
22272
ac4a1dcf494c #DOCUMENTATION by stefan
Stefan Vogel <sv@exept.de>
parents: 20649
diff changeset
    94
    ^ 16r-8000
ac4a1dcf494c #DOCUMENTATION by stefan
Stefan Vogel <sv@exept.de>
parents: 20649
diff changeset
    95
ac4a1dcf494c #DOCUMENTATION by stefan
Stefan Vogel <sv@exept.de>
parents: 20649
diff changeset
    96
    "Modified (format): / 19-09-2017 / 16:31:41 / stefan"
20649
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    97
! !
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    98
22272
ac4a1dcf494c #DOCUMENTATION by stefan
Stefan Vogel <sv@exept.de>
parents: 20649
diff changeset
    99
20649
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   100
!SignedWordArray class methodsFor:'documentation'!
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   101
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   102
version
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   103
    ^ '$Header$'
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   104
!
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   105
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   106
version_CVS
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   107
    ^ '$Header$'
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   108
! !
772b93b7f97a initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   109