Class: RunArray

• Inheritance
• Description
• Related information
• Class protocol
  • instance creation
• Instance protocol
  • Compatibility-ST80
  • accessing
  • adding & removing
  • comparing
  • converting
  • copying
  • copying-private
  • enumerating
  • misc ui support
  • printing & storing
  • private
  • private-growing
  • queries
  • searching
• Examples

Inheritance:

   Object
   |
   +--Collection
      |
      +--SequenceableCollection
         |
         +--RunArray

Package:

stx:libbasic2

Category:

Collections-Sequenceable

Version:

rev: 1.53 date: 2019/05/27 13:04:08

user: cg

file: RunArray.st directory: libbasic2

module: stx stc-classLibrary: libbasic2

Author:

Claus Gittinger

Description:

This implements an array which uses runs to minimise the amount
of data that it physically holds. 
A run consists of a count/object pair, which (when the collection
is accessed), is treated as if the object was contained count-times 
in the runArray.

Basically it can be used if you know that your collection is 
going to contain a lot of runs of exactly the same data. 

RunArrays are used by the Text class to keep character attributes
(which we expect to remain constant for longer character ranges).

[notice:]
    there is ONLY a space saving if there are really runs 
    (i.e. multiple elements which compare same).
    The break-even is when runs have an average size of 2 elements,
    if average runs are shorter, other collections (i.e. Array or
    OrderedCollection) are more compact.

    Also note that indexed access (i.e. #at: / #at:put:) may be
    very inefficient (as opposed to enumeration, which is reasonably
    fast).
    The reason is that for indexed access the runs have to be walked.
    When storing into a runArray, runs may have to be splitted or merged,
    depending on where the store is done (within a run).
    This may lead to a resize operation.
    You have been warned.

[instance variables:]
    contentsArray    <Array>         contains the runs, consisting of
                                     alternating length/value entries.

[implementation note:]
    structure-wise, it would have been more intuitive, to keep
    instances of Run objects (as done in CompressedOrderedCollection)
    instead of alternating length/values in the `runs' collection.
    However, doing this means that lots of additional memory is required,
    since for every run, another object (consisting of 12bytes header)
    would be needed.
    Here, we choose the more space efficient way - after all, space saving
    is the only reason this class was built for.

Related information:

    Array
    OrderedCollection
    CompressedOrderedCollection

Class protocol:

 from: aSequencableCollection

return a new runArray, containing the elements from aSequencableCollection

usage example(s):

RunArray from:#(1 2 3 3 3 4 5 5 6 6 6 6 6 6)

 new: count

return a new runArray, containing count elements - all nil

 new: count withAll: anObject

create a new runArray with count elements, all being anObject

usage example(s):

RunArray new:100 withAll:#hello

 runs: runs values: values

return a new runArray, containing elements defined by pairs from
runs and values

usage example(s):

RunArray runs:#(2 3 4) values:#($a $b $c)

Instance protocol:

 runs

|c|

c := RunArray new.
c add:1 withOccurrences:1000.
c add:2 withOccurrences:1000.
c runs.

 values

|c|

c := RunArray new.
c add:1 withOccurrences:1000.
c add:2 withOccurrences:1000.
c values.

 at: index

Answer the element at index.
at: is used by a knowledgeable client to access an existing element
This is a pretty dumb thing to do to a runArray and it is
not at all efficient (think of that as a discouragement).

 at: index put: anObject

Put anObject at element index anInteger.
at:put: can not be used to append, front or back, to a runArray.
It is used by a knowledgeable client to replace an element.
This is a pretty dumb thing to do to a runArray and it is
very inefficient, since we have to check if runs are to be merged or
splitted.

 atAllPut: anObject

replace all elements of the collection by the argument, anObject.
Return the receiver.
Notice: This operation modifies the receiver, NOT a copy;
therefore the change may affect all others referencing the receiver.

 add: newObject

add newObject at the end.
Returns the object (sigh)

 add: newObject withOccurrences: n

add newObject n times at the end; returns the object (sigh)

 addAll: aCollection

add all elements of the argument, aCollection to the receiver.
Returns the argument, aCollection (sigh).

 = aCollection

return true, if the argument contains the same elements as the receiver.
Optimized, especially for the common case, that collection is another runArray

usage example(s):

'hello' asText sameStringAndEmphasisAs: 'hello' asText 'hello' asText sameStringAndEmphasisAs: 'hello' asText allBold 'hello' asText allBold sameStringAndEmphasisAs: 'hello' asText allBold 'hello1' asText allBold sameStringAndEmphasisAs: 'hello' asText allBold 'hello' asText allBold sameStringAndEmphasisAs: 'hello1' asText allBold ('hello' asText allBold , ' ') sameStringAndEmphasisAs: 'hello ' asText allBold ('hello ' asText allBold) sameStringAndEmphasisAs: ('hello' asText allBold , ' ') ('hello' asText allBold , ' ') sameStringAndEmphasisAs: ('hello' asText allBold , ' ') 'hello' asRunArray = 'hello' asRunArray 'hello1' asRunArray = 'hello' asRunArray 'hello' asRunArray = 'hello1' asRunArray 'hello' asRunArray = 'hello' asArray 'hello1' asRunArray = 'hello' asArray 'hello' asRunArray = 'hello1' asArray

 asArray

return a new array, containing the receiver's elements.

 asOrderedCollection

return a new orderedCollection, containing the receiver's elements.

 asRunArray

return the receiver itself

 copyFrom: start to: stop

return a new collection, containing the elements from start to stop

 postCopy

 conform: aBlock

return true, if every element conforms to some condition.
I.e. return false, if aBlock returns false for any element;
true otherwise. Returns true for empty receivers.

 contains: aBlock

Return true, if aBlock returns true for any of the receiver's elements

 do: aBlock

Evaluate aBlock with each of the receiver's elements as the
argument.

 runsDo: aBlock

Evaluate aBlock with each of the receiver's runs,
passing length and value as arguments.

 withStartStopAndValueDo: aThreeArgBlock

Evaluate aBlock with each of the receiver's runs, passing
start, end and attributes as arguments.

 inspectorClass
( an extension from the stx:libtool package )

Re-reimplemented so that we don't get an ordered collection inspector
which would get very confused when confronted with a runArray.

 displayOn: aGCOrStream

Append to aStream an expression which, if evaluated, will generate
an object similar to the receiver.

 storeOn: aStream

Append to aStream an expression which, if evaluated, will generate
an object similar to the receiver.

 find: oldObject

If I contain oldObject return its index, otherwise create an error
notifier. It will answer with the position of the very first element of
that value.
OBSOLETE: this is a leftover from earlier times; use #indexOf:ifAbsent:

** This is an obsolete interface - do not use it (it may vanish in future versions) **

 find: oldObject ifAbsent: exceptionBlock

If I contain oldObject return its index, otherwise execute the
exception block. It will answer with the position of the very first
element of that value.
OBSOLETE: this is a leftover from earlier times; use #indexOf:ifAbsent:

** This is an obsolete interface - do not use it (it may vanish in future versions) **

 getContentsArray

 runIndexAndStartIndexForIndex: anIndex

given a logical index, find the index of that run and the logical index
of the first item in that run.

 setElement: newObject occurrences: n

private instance setup

 setElementsFrom: aCollection

set my elements from aCollection

 setElementsFromRuns: runs values: values

 setRuns: runs setValues: values

 grow: howBig

grow or shrink the receiver to contain howBig elements.
If growing, new slots will be filled (logically) with nil.

 includes: anElement

return true, if the receiver includes an element which is equal
to the argument, anElement; false otherwise.
Redefined to prevent the inherited loop over individual accesses via #at:,
which would be very inefficient.

 includesIdentical: anElement

return true, if the receiver includes the argument, anElement; false otherwise.
Redefined to prevent the inherited loop over individual accesses via #at:,
which would be very inefficient.

 isEmpty

Am I empty or not. Returns a boolean

 size

Answer how many elements the receiver contains.
This is not the number of runs (but the simulated number of elements).

 findFirst: aBlock ifNone: exceptionalValue

find the index of the first element, for which evaluation of the argument, aBlock
returns true; return its index or 0 if none detected.
Notice, that not all elements are processed here
(the block is only evaluated for each runs first element).

usage example(s):

(RunArray new add:1 withOccurrences:100; add:2 withOccurrences:100; add:3 withOccurrences:100; add:4 withOccurrences:100; yourself) findFirst:[:el | el == 3]

 identityIndexOf: anElement startingAt: start

search for identical anElement, return the index or 0 if not found.
Redefined to prevent a loop over individual accesses via #at:,
which would be very inefficient.

 indexOf: anElement startingAt: start

search for equal anElement, return the index or 0 if not found.
Redefined to prevent a loop over individual accesses via #at:,
which would be very inefficient.

Examples:

  |coll|

  coll := OrderedCollection new.
  Transcript showCR:(    
      Time millisecondsToRun:[
          100000 timesRepeat:[coll add:'hello'].
          100000 timesRepeat:[coll add:'world'].
      ]
  ).
  coll inspect.

  |coll|

  coll := RunArray new.
  Transcript showCR:(    
      Time millisecondsToRun:[
          100000 timesRepeat:[coll add:'hello'].
          100000 timesRepeat:[coll add:'world'].
      ]
  ).
  coll inspect.

  |coll|

  coll := RunArray new.
  Transcript showCR:(    
      Time millisecondsToRun:[
          coll add:'hello' withOccurrences:100000.
          coll add:'world' withOccurrences:100000.
      ]
  ).
  coll inspect.

  |coll|

  coll := RunArray new.
  Transcript showCR:(    
      Time millisecondsToRun:[
          1 to:1000 do:[:i | coll add:i].
      ]
  ).

  |coll|

  coll := OrderedCollection new.
  Transcript showCR:(    
      Time millisecondsToRun:[
          1 to:1000 do:[:i | coll add:i].
      ]
  ).