faal_algo

Class FAAL

java.lang.Object

faal_algo.FAAL

public class FAAL
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
FAAL()

Method Summary

Modifier and Type	Method and Description
static java.util.List<java.util.List<java.lang.Object>>	faal(java.lang.String word_A, java.lang.String word_B, java.lang.Boolean print_res) Method containing the whole FAAL algorithm, using default values (see online documentation for their values).
static java.util.List<java.util.List<java.lang.Object>>	faal(java.lang.String word_A, java.lang.String word_B, java.lang.Boolean print_res, java.lang.Boolean external_function) Method containing the whole FAAL algorithm, using default values but with the option of using an external Global Corrected Similarity Score function (see online documentation for their values).
static java.util.List<java.util.List<java.lang.Object>>	faal(java.lang.String word_A, java.lang.String word_B, java.lang.Boolean external_function, java.util.List<java.lang.String> IPA_configs, java.util.List<java.lang.Boolean> Matcher_configs_1, java.util.List<java.lang.Integer> Matcher_configs_2, java.util.List<java.lang.String> Matcher_configs_3, java.util.List<java.lang.Double> Matcher_configs_4) Method containing the whole FAAL algorithm, using personalized values (see online documentation for detailed description).

Methods inherited from class java.lang.Object

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

Constructor Detail

FAAL

public FAAL()

Method Detail

faal

public static java.util.List<java.util.List<java.lang.Object>> faal(java.lang.String word_A,
                                                                    java.lang.String word_B,
                                                                    java.lang.Boolean print_res)

Method containing the whole FAAL algorithm, using default values (see online documentation for their values).

Parameters:

word_A - (String): IPA transcription of the first word to be aligned.

word_B - (String): IPA transcription of the second word to be aligned.

print_res - (Boolean): print the results in the console - True = print all the alignments found; False = print only the best alignment.

Returns:

Result output: List<List<Object>>

Each List<Object> item within the List corresponds to an alignment. They are organized according to their Global or Corrected Global Similarity score (see the config files in the documentation online). Each of these List<Object> item contains:

0. String: Alignment for Word A

1. String: Alignment for Word B

2. String: Alignment for Word A without diacritics

3. String: Alignment for Word B without diacritics

4. Double: Global Similarity Score

5. Double: Corrected Global Similarity Score

6. List<String>: List of phonetic pairs attested within the alignment. Each item on the list corresponds to a phonetic pair, and it is stored as a string with the following syntax: "phoneme_A - phoneme_B"

7. List<Integer>: Number of attestations within the alignment for each phonetic pair of point 6. here above.

faal

public static java.util.List<java.util.List<java.lang.Object>> faal(java.lang.String word_A,
                                                                    java.lang.String word_B,
                                                                    java.lang.Boolean print_res,
                                                                    java.lang.Boolean external_function)

Method containing the whole FAAL algorithm, using default values but with the option of using an external Global Corrected Similarity Score function (see online documentation for their values).

Parameters:

word_A - (String): IPA transcription of the first word to be aligned.

word_B - (String): IPA transcription of the second word to be aligned.

print_res - (Boolean): print the results in the console - True = print all the alignments found; False = print only the best alignment.

external_function - (Boolean): select if using or not an external function - True = use external function from config. folder; False = do not use external function.

Returns:

Result output: List<List<Object>>

Each List<Object> item within the List corresponds to an alignment. They are organized according to their Global or Corrected Global Similarity score (see the config files in the documentation online). Each of these List<Object> item contains:

0. String: Alignment for Word A

1. String: Alignment for Word B

2. String: Alignment for Word A without diacritics

3. String: Alignment for Word B without diacritics

4. Double: Global Similarity Score

5. Double: Corrected Global Similarity Score

6. List<String>: List of phonetic pairs attested within the alignment. Each item on the list corresponds to a phonetic pair, and it is stored as a string with the following syntax: "phoneme_A - phoneme_B"

7. List<Integer>: Number of attestations within the alignment for each phonetic pair of point 6. here above.

faal

public static java.util.List<java.util.List<java.lang.Object>> faal(java.lang.String word_A,
                                                                    java.lang.String word_B,
                                                                    java.lang.Boolean external_function,
                                                                    java.util.List<java.lang.String> IPA_configs,
                                                                    java.util.List<java.lang.Boolean> Matcher_configs_1,
                                                                    java.util.List<java.lang.Integer> Matcher_configs_2,
                                                                    java.util.List<java.lang.String> Matcher_configs_3,
                                                                    java.util.List<java.lang.Double> Matcher_configs_4)

Method containing the whole FAAL algorithm, using personalized values (see online documentation for detailed description).

Parameters:

word_A - (String): IPA transcription of the first word to be aligned.

word_B - (String): IPA transcription of the second word to be aligned.

external_function - (Boolean): select if using or not an external function - True = use external function from config. folder; False = do not use external function.

IPA_configs - (List<String>): String array list with variables for the configuration of the IPA_parser.IPA_parser_new module. For a detailed description of the variables see online documentation.

Matcher_configs_1 - (List<Boolean>): Boolean array list with variables for the configuration of the FAAL.faal and Matcher.Matcher_new modules. For a detailed description of the variables see online documentation.

Matcher_configs_2 - (List<Integer>): Integer array list with variables for the configuration of the FAAL.faal and Matcher.Matcher_new modules. For a detailed description of the variables see online documentation.

Matcher_configs_3 - (List<String>): String array list with variables for the configuration of the FAAL.faal and Matcher.Matcher_new modules. For a detailed description of the variables see online documentation.

Matcher_configs_4 - (List<Double>): Double array list storing the factors used in the calculation of the Corrected Global Similarity score. It is used in the configuration of the FAAL.faal and Matcher.Matcher_new modules For a detailed description of the variables see online documentation.

Returns:

Result output: List<List<Object>>

Each List<Object> item within the List corresponds to an alignment. They are organized according to their Global or Corrected Global Similarity score (see the config files in the documentation online). Each of these List<Object> item contains:

0. String: Alignment for Word A

1. String: Alignment for Word B

2. String: Alignment for Word A without diacritics

3. String: Alignment for Word B without diacritics

4. Double: Global Similarity Score

5. Double: Corrected Global Similarity Score

6. List<String>: List of phonetic pairs attested within the alignment. Each item on the list corresponds to a phonetic pair, and it is stored as a string with the following syntax: "phoneme_A - phoneme_B"

7. List<Integer>: Number of attestations within the alignment for each phonetic pair of point 6. here above.