-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | A library to work with the basic Ukrainian phonetics and syllable segmentation.
--   
--   A library to work with the basic Ukrainian phonetics and syllable
--   segmentation. Rewritten from the mmsyn6ukr and mmsyn7s packages.
@package ukrainian-phonetics-basic
@version 0.2.0.0


-- | Functions provide functionality of a musical instrument synthesizer or
--   for Ukrainian speech synthesis especially for poets, translators and
--   writers. Is rewritten from the module Melodics.Ukrainian from the
--   <tt>mmsyn6ukr</tt> package :
--   '<a>https://hackage.haskell.org/package/mmsyn6ukr'</a> Phonetic
--   material is taken from the :
--   
--   Solomija Buk, Ján Mačutek, Andrij Rovenchak. Some properties of the
--   Ukrainian writing system. [Electronic resource]
--   <a>https://arxiv.org/ftp/arxiv/papers/0802/0802.4198.pdf</a>
module Melodics.ByteString.Ukrainian
convertToProperUkrainianS :: String -> String
convertToProperUkrainianV2S :: Vector Char -> String

-- | The function that converts a written Ukrainian text into the sounding
--   in the program phonetical respesentation. It is not exact phonetically
--   but you can make for yourself a general impression of the Ukrainian
--   sounding.
convertToProperUkrainian :: String -> Vector Char

-- | The function that converts a written Ukrainian text into the sounding
--   in the program phonetical respesentation. It is not exact phonetically
--   but you can make for yourself a general impression of the Ukrainian
--   sounding.
convertToProperUkrainianV :: Vector Char -> Vector Char

-- | Unlike the <a>convertToProperUkrainian</a>, it returns a boxed
--   <a>Vector</a> instead of unboxed one <a>Vector</a>, @ since 0.1.2.0
convertToProperUkrainianX :: String -> Vector Char

-- | Unlike the <a>convertToProperUkrainianV</a>, it returns a boxed
--   <a>Vector</a> instead of unboxed one <a>Vector</a>, @ since 0.1.2.0
convertToProperUkrainianV2X :: Vector Char -> Vector Char

-- | A variant of the <a>convertToProperUkrainian</a> with the
--   <a>ByteString</a> result.
convertToProperUkrainianB :: String -> ByteString

-- | A variant of the <a>convertToProperUkrainianV</a> with the
--   <a>ByteString</a> result.
convertToProperUkrainianV2B :: Vector Char -> ByteString
isUkrainianL :: Char -> Bool
linkFileName :: Char -> Char
showInteresting :: String -> ByteString
instance GHC.Show.Show Melodics.ByteString.Ukrainian.Triple
instance GHC.Classes.Ord Melodics.ByteString.Ukrainian.Triple
instance GHC.Classes.Eq Melodics.ByteString.Ukrainian.Triple


-- | This module works with syllable segmentation in Ukrainian. It is
--   rewritten module MMSyn7.Syllable from the <tt>mmsyn7s</tt> package :
--   <a>https://hackage.haskell.org/package/mmsyn7s</a>
module Languages.Phonetic.Ukrainian.Syllable
data UZPP a b
UZ :: a -> b -> UZPP a b
data PhoneticType
W :: PhoneticType
S :: PhoneticType
O :: PhoneticType
D :: PhoneticType
K :: PhoneticType
L :: PhoneticType
M :: PhoneticType
N :: PhoneticType
E :: PhoneticType
type UZPP2 = UZPP Char PhoneticType
phoneType :: UZPP2 -> PhoneticType
charUkr :: UZPP2 -> Char
vec2UZPP2s :: Vector Char -> [UZPP2]

-- | Function-predicate <a>isVowel1</a> checks whether its argument is a
--   vowel representation in the <a>UZPP2</a> format.
isVowel1 :: UZPP2 -> Bool

-- | Function-predicate <a>isVwl</a> checks whether its argument is a vowel
--   representation in the <a>Char</a> format.
isVwl :: Char -> Bool

-- | Function-predicate <a>isSonorous1</a> checks whether its argument is a
--   sonorous consonant representation in the <a>UZPP2</a> format.
isSonorous1 :: UZPP2 -> Bool

-- | Function-predicate <a>isVoicedC1</a> checks whether its argument is a
--   voiced consonant representation in the <a>UZPP2</a> format.
isVoicedC1 :: UZPP2 -> Bool

-- | Function-predicate <tt>isVoiceless1</tt> checks whether its argument
--   is a voiceless consonant representation in the <a>UZPP2</a> format.
isVoicelessC1 :: UZPP2 -> Bool

-- | Binary function-predicate <a>isNotVowel2</a> checks whether its
--   arguments are both consonant representations in the <a>UZPP2</a>
--   format.
isNotVowel2 :: UZPP2 -> UZPP2 -> Bool

-- | Binary function-predicate <a>notEqC</a> checks whether its arguments
--   are not the same consonant sound representations (not taking
--   palatalization into account).
notEqC :: UZPP2 -> UZPP2 -> Bool

-- | Function <a>sndGroups</a> converts a Ukrainian word being a list of
--   <a>UZPP2</a> to the list of phonetically similar (consonants grouped
--   with consonants and each vowel separately) sounds representations in
--   <a>UZPP2</a> format.
sndGroups :: [UZPP2] -> [[UZPP2]]

-- | Function <a>vecWords</a> similarly to <a>words</a> divides a
--   <a>Vector</a> of <a>Char</a> into list of them, each element of which
--   is a Ukrainian word (or its part for dashed and hyphenated words or
--   that ones with an apostrophe).
vecWords :: Vector Char -> [Vector Char]
groupSnds :: [UZPP2] -> [[UZPP2]]

-- | Function <a>divCnsnts</a> is used to divide groups of Ukrainian
--   consonants into two-elements lists that later are made belonging to
--   different neighbour syllables if the group is between two vowels in a
--   word. The group must be not empty, but this is not checked. The
--   phonetical information for the proper performance is taken from the:
--   <a>https://msn.khnu.km.ua/pluginfile.php/302375/mod_resource/content/1/%D0%9B.3.%D0%86%D0%86.%20%D0%A1%D0%BA%D0%BB%D0%B0%D0%B4.%D0%9D%D0%B0%D0%B3%D0%BE%D0%BB%D0%BE%D1%81.pdf</a>
divCnsnts :: [UZPP2] -> ([UZPP2] -> [UZPP2], [UZPP2] -> [UZPP2])
reSyllableCntnts :: [[UZPP2]] -> [[UZPP2]]
divVwls :: [[UZPP2]] -> [[UZPP2]]
createSyllablesUkr :: String -> [[[UZPP2]]]
createSyllablesUkrP :: String -> [[[UZPP2]]]
createSyllablesUkrV :: Vector Char -> [[[UZPP2]]]
createSyllablesUkrVP :: Vector Char -> [[[UZPP2]]]

-- | Function <a>representProlonged</a> converts duplicated consequent in
--   the syllable consonants so that they are represented by just one
--   <a>UZPP2</a>. After applying the function to the list of <a>UZPP2</a>
--   being a syllable all groups of duplicated consequent consonants in
--   every syllable are represented with only one <a>UZPP2</a>
--   respectively.
representProlonged :: [UZPP2] -> [UZPP2]

-- | Is inspired by the DobutokO.Sound.DIS5G6G module from
--   <tt>dobutokO2</tt> package. See:
--   '<a>https://hackage.haskell.org/package/dobutokO2-0.43.0.0/docs/DobutokO-Sound-DIS5G6G.html'</a>.
--   The <a>Float</a> data are gotten from there.
str2Durat1 :: String -> Float

-- | Just another possible duration approximation obtained by usage of the
--   <tt>r-glpk-phonetic-languages-ukrainian-durations</tt> package
--   <a>https://hackage.haskell.org/package/r-glpk-phonetic-languages-ukrainian-durations</a>
uzpp2Durat2 :: UZPP2 -> Float
uzpp2Durat1 :: UZPP2 -> Float

-- | General variant of the <a>syllableDurations</a> function with the
--   arbitrary <a>uzpp2Durat1</a>-like function.
syllableDurationsG :: (UZPP2 -> Float) -> [[[UZPP2]]] -> [[Float]]

-- | Returns list of lists, every inner one of which contains approximate
--   durations of the Ukrainian syllables.
syllableDurations :: [[[UZPP2]]] -> [[Float]]

-- | Likewise <a>syllableDurations</a>, but uses <a>uzpp2Durat2</a> instead
--   of <a>uzpp2Durat1</a>.
syllableDurations2 :: [[[UZPP2]]] -> [[Float]]
instance (GHC.Classes.Eq a, GHC.Classes.Eq b) => GHC.Classes.Eq (Languages.Phonetic.Ukrainian.Syllable.UZPP a b)
instance GHC.Classes.Ord Languages.Phonetic.Ukrainian.Syllable.PhoneticType
instance GHC.Classes.Eq Languages.Phonetic.Ukrainian.Syllable.PhoneticType
instance GHC.Show.Show (Languages.Phonetic.Ukrainian.Syllable.UZPP GHC.Types.Char Languages.Phonetic.Ukrainian.Syllable.PhoneticType)
instance (GHC.Classes.Ord a, GHC.Classes.Ord b) => GHC.Classes.Ord (Languages.Phonetic.Ukrainian.Syllable.UZPP a b)