swarm.collections
Interface ListShufflerC

All Known Implementing Classes:
ListShufflerCImpl

public interface ListShufflerC
extends CreateS, CreateC, DropS, DropC

A class to randomize the order of a given Swarm List. ListShuffler randomizes the order of the elements in a List; either the whole list or the num lowest elements. The list must be supplied. An uniform distribution can be supplied, or the system- supplied uniformUnsRand is used. The algorithm is from Knuth. All these methods modify the underlying collection, so any indexes should always be regenerated.


Method Summary
 Object create$setUniformRandom(Zone aZone, Object dist)
          The create:setUniformRandom method creates the Shuffler and connects the supplied distribution object.
 Object createEnd()
           
 Object setUniformRandom(Object dist)
          the setUniformRandom: method connects the supplied uniform distribution to the Shuffler (run after createBegin:).
 
Methods inherited from interface swarm.defobj.CreateC
create, createBegin
 
Methods inherited from interface swarm.defobj.CustomizeC
customizeBegin, customizeCopy, customizeEnd
 

Method Detail

setUniformRandom

public Object setUniformRandom(Object dist)
the setUniformRandom: method connects the supplied uniform distribution to the Shuffler (run after createBegin:).

createEnd

public Object createEnd()
Specified by:
createEnd in interface CreateC

create$setUniformRandom

public Object create$setUniformRandom(Zone aZone,
                                      Object dist)
The create:setUniformRandom method creates the Shuffler and connects the supplied distribution object.