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