Wordgames

Utilities

Enigmistics.clean_read — Function

clean_read(filename::AbstractString; newline_replace=" ")

Read a text file and return a string containing its contents.

The returned string is cleaned up to work better with the functions of the Enigmistics module. For example: multiple occurrences of newlines, spaces, or tabs get reduced to a single space (newlines information can be preserved by setting a different character in newline_replace).

Examples

julia> readlines("../texts/commedia.txt")[1:9] # simple read
9-element Vector{String}:
 "LA DIVINA COMMEDIA"
 "di Dante Alighieri"
 "INFERNO"
 ""
 ""
 ""
 "Inferno: Canto I"
 ""
 "  Nel mezzo del cammin di nostra vita"

julia> join(readlines(filename), " ")[1:107] # simple read + join
"LA DIVINA COMMEDIA di Dante Alighieri      INFERNO  Inferno: Canto I    Nel mezzo del cammin di nostra vita"

julia> clean_read(filename)[1:98] # clean read
"LA DIVINA COMMEDIA di Dante Alighieri INFERNO Inferno: Canto I Nel mezzo del cammin di nostra vita"

julia> clean_read(filename, newline_replace="/")[1:104] # clean read + newline replacement
"LA DIVINA COMMEDIA di Dante Alighieri / INFERNO / Inferno: Canto I / Nel mezzo del cammin di nostra vita"

source

Enigmistics.clean_text — Function

clean_text(s::AbstractString; newline_replace=" ")

Take a string and return a cleaned up version of it.

This allows to work better with the functions of the Enigmistics module. For example: multiple occurrences of newlines, spaces, or tabs get reduced to a single space (newlines information can be preserved by setting a different character in newline_replace).

It's the function on which clean_read relies on.

source

Enigmistics.count_letters — Function

count_letters(s::AbstractString)
count_letters(s::Vector{AbstractString})

Count the number of alphabetic characters in a string.

Examples

julia> s = "This sentence has thirty-one letters";

julia> count_letters(s) # 31
31

julia> length(s) # 36 = 31 letters + 4 spaces + 1 hyphen
36

source

Enigmistics.snip — Function

snip(text::String, interval::UnitRange{Int}, pad=10)

Extract a snippet of text from a given range, enlarged on both sides by the given padding.

Examples

julia> text = "abcdefghijklmnopqrstuvwxyz";

julia> snip(text,13:14,0)
"mn"

julia> snip(text,13:14,2)
"klmnop"

source

Anagrams

Enigmistics.are_anagrams — Function

are_anagrams(s1::AbstractString, s2::AbstractString; be_strict=true)
are_anagrams(s1::Vector{String}, s2::Vector{String}; be_strict=true)

Check if two strings are anagrams, i.e. if the letters of one can be rearranged to form the other.

The parameter be_strict is defaulted to true to avoid considering as anagrams strings where one is simply a permutation of the other.

Pangrams

Enigmistics.is_pangram — Function

is_pangram(s::AbstractString; language="en", verbose=false)

Check if a string is a pangram, i.e. if it contains at least once all the letters of the alphabet.

The language parameter can be used to specify which alphabet to use (currently supported values are "en", English and "it", Italian). In particular, the english case consists of the vector collect('a':'z') while the italian one of the english vector having removed characters 'jwxyz'. If verbose is set to true the function will also inform, in case of non-pangrams, which were the missing letters.

Palindromes

Enigmistics.is_palindrome — Function

is_palindrome(s::AbstractString)

Check if a string is palindrome, i.e. if it reads the same backward as forward.

Heterograms

Enigmistics.is_heterogram — Function

is_heterogram(s::AbstractString)

Check if a string is a heterogram, i.e. if it does not contain any repeated letter.

Lipograms

Enigmistics.is_lipogram — Function

is_lipogram(s::AbstractString, wrt::AbstractString)

Check if a string s is a lipogram with respect to the letters given by wrt, i.e. if s does not contain any letters from wrt.

The parameter wrt is a string so that single or multiple letters can be easily specified.

Tautograms

Enigmistics.is_tautogram — Function

is_tautogram(s::AbstractString)

Check if a given string is a tautogram, i.e. if all words in the string start with the same letter.

Abecedaries

Enigmistics.is_abecedary — Function

is_abecedary(s::AbstractString; language="en")

Check if a string is an abecedary, i.e. if it consists of a sequence of words whose initials are in alphabetical order.