SymbolGenerator

Generates random symbols from on a pool of weighted values.

Implements: Archigen.IGenerator<System.String>, IRandomizable

Constructors

Constructor
Description

SymbolGenerator()

Instantiates a new SymbolGenerator.

SymbolGenerator(System.String symbols)

Instantiates a new SymbolGenerator with the provided symbols. Each character in the string is considered a separate symbol.

Methods

Method
Returns
Description

Add(System.String symbols)

Adds the symbols in the provided string to this generator. Each character in the string is considered a separate symbol.

Cluster(System.String[] clusters)

Adds provided symbol clusters (sequences) to this generator. Each argument regardless of its length is considered a single symbol.

Copy()

Creates a deep copy of this SymbolGenerator excluding the Syllabore.SymbolGenerator.Random property.

Next()

System.String

Returns a random Symbol as a string. Symbol with higher weights are more likely to be selected.

Weight(System.Int32 weight)

Sets the weight of the most recently added symbols. This method should be called immediately after Syllabore.SymbolGenerator.Add or Syllabore.SymbolGenerator.Cluster.

Properties

Property
Type
Description

Random

System.Random

The instance of System.Random used to simulate randomness.

Symbols

System.Collections.Generic.List <Symbol>

The possible Symbol that can be generated by this generator.

Last updated