GenLetterByFreqNet 4.0.1

ABOUT:

• GenLetterByFreqNet generates random characters. The odds of how likely a character will be generated are based on weighted percent values. With this library, you can easily generate random characters while fine-tuning the chances of specific characters appearing.

• By default, this library randomly generates characters (a–z) based on how frequently the characters are used in the Oxford English Dictionary. So commonly used letters like 'e' are much more likely to be randomly generated compared to rarer letters like 'z'. The data behind these percentage weights can be found here: https://www3.nd.edu/~busiforc/handouts/cryptography/letterfrequencies.html

• The user also has the option to fine-tune odds by overriding the default a–z character table by providing a custom dictionary, where each key is a character and the key's corresponding value represents the percentage likelihood of that character being randomly generated.

GET STARTED:

• To use default (a-z) values and their corresponding weight percentages based on how frequently the characters are used in the Oxford Dictionary, simply create a CharGenerator instance with no constructor args:

 CharGenerator OxfordLetterGenerator = new CharGenerator();

• To use a custom character list with custom frequency values, pass in a generic Dictionary. The key being a unique character and the value representing the likelihood of that character generating:

// Dictionary<char, double>: Each key is a character, and each value defines the probability of that character being generated.
CharGenerator CustomCharacterChartGenerator = new CharGenerator(new Dictionary<char, double> { {'4', 50}, {'k', 50} }); 
// This character generator will have a 50% chance of generating a '4' character and a 50% chance of generating a 'k' character

USE:

• How to a generate random character:

//generates single character randomly
char randChar = OxfordLetterGenerator.GetRandomCharacter();

• How to generate a random string:

int amount = 10;
//will generate 10 random characters
string randStr = OxfordLetterGenerator.GetRandomCharacters(amount); 

EXCEPTIONS:

• InvalidCharacterAmountException: if GetRandomCharacters(int amount) method is called with a number less than or equal to 0.

• InvalidWeightException: if a weight value in the custom dictionary that was passed into the CharGenerator constructor is too small (less than 0.00001).

• ChartMappingFailureException: Unexpected error occurred during frequency chart building process.

• InvalidDictException: If constructor dictionary parameter is empty or size is greater than 10,000.