squidpony

Class WeightedLetterNamegen

java.lang.Object

squidpony.WeightedLetterNamegen

public class WeightedLetterNamegen
extends java.lang.Object

Based on work by Nolithius available at the following two sites https://github.com/Nolithius/weighted-letter-namegen http://code.google.com/p/weighted-letter-namegen/

See Also:

FakeLanguageGen is meant for generating more than just names, and can imitate language styles.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	COMMON_USA_FEMALE_NAMES
static java.lang.String[]	COMMON_USA_LAST_NAMES
static java.lang.String[]	COMMON_USA_MALE_NAMES
static java.lang.String[]	LOVECRAFT_MYTHOS_NAMES
static java.lang.String[]	STAR_WARS_STYLE_NAMES
static java.lang.String[]	VIKING_STYLE_NAMES

Constructor Summary

Constructors

Constructor and Description
WeightedLetterNamegen(java.lang.String[] names) Creates the generator by seeding the provided list of names.
WeightedLetterNamegen(java.lang.String[] names, int consonantLimit) Creates the generator by seeding the provided list of names.
WeightedLetterNamegen(java.lang.String[] names, int consonantLimit, IStatefulRNG rng) Creates the generator by seeding the provided list of names.

Method Summary

Modifier and Type	Method and Description
java.lang.String	generate() Gets one random String name.
java.lang.String[]	generate(int amountToGenerate) Gets an array of random String names, sized to match amountToGenerate.
java.util.ArrayList<java.lang.String>	generateList(int amountToGenerate) Gets an ArrayList of random String names, sized to match amountToGenerate.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VIKING_STYLE_NAMES

public static final java.lang.String[] VIKING_STYLE_NAMES

STAR_WARS_STYLE_NAMES

public static final java.lang.String[] STAR_WARS_STYLE_NAMES

COMMON_USA_MALE_NAMES

public static final java.lang.String[] COMMON_USA_MALE_NAMES

COMMON_USA_FEMALE_NAMES

public static final java.lang.String[] COMMON_USA_FEMALE_NAMES

COMMON_USA_LAST_NAMES

public static final java.lang.String[] COMMON_USA_LAST_NAMES

LOVECRAFT_MYTHOS_NAMES

public static final java.lang.String[] LOVECRAFT_MYTHOS_NAMES

Constructor Detail

WeightedLetterNamegen

public WeightedLetterNamegen(java.lang.String[] names)

Creates the generator by seeding the provided list of names.

Parameters:

names - an array of Strings that are typical names to be emulated

WeightedLetterNamegen

public WeightedLetterNamegen(java.lang.String[] names,
                             int consonantLimit)

Creates the generator by seeding the provided list of names.

Parameters:

names - an array of Strings that are typical names to be emulated

consonantLimit - the maximum allowed consonants in a row

WeightedLetterNamegen

public WeightedLetterNamegen(java.lang.String[] names,
                             int consonantLimit,
                             IStatefulRNG rng)

Creates the generator by seeding the provided list of names. The given RNG will be used for all random decisions this has to make, so if it has the same state (and RandomnessSource) on different runs through the program, it will produce the same names reliably.

Parameters:

names - an array of Strings that are typical names to be emulated

consonantLimit - the maximum allowed consonants in a row

rng - the source of randomness to be used

Method Detail

generate

public java.lang.String generate()

Gets one random String name.

Returns:

a single random String name

generateList

public java.util.ArrayList<java.lang.String> generateList(int amountToGenerate)

Gets an ArrayList of random String names, sized to match amountToGenerate.

Parameters:

amountToGenerate - how many String items to include in the returned ArrayList

Returns:

an ArrayList of random String names

generate

public java.lang.String[] generate(int amountToGenerate)

Gets an array of random String names, sized to match amountToGenerate.

Parameters:

amountToGenerate - how many String items to include in the returned array

Returns:

an array of random String names