Record Class IndexOfPhoneticComplexity

java.lang.Object
java.lang.Record
ca.phon.ipa.ipc.IndexOfPhoneticComplexity
public record IndexOfPhoneticComplexity(int D, int M, int V, int S, int L, int P, int C, int T, String explanation) extends Record
Index of phonetic complexity components. Jakielski, Kathy J.. "The Index of Phonetic Complexity: At-a-Glance Scoring System, Terminology, Instructions, invalid input: '&' Data Forms" (2022). Building Speech and Quantifying Complexity. https://digitalcommons.augustana.edu/csdbuildingspeech/10

  • Constructor Summary

    Constructors
    Constructor
    Description
    IndexOfPhoneticComplexity()
    Default constructor for the Index of Phonetic Complexity.
    IndexOfPhoneticComplexity(int D, int M, int V, int S, int L, int P, int C, int T, String explanation)
    Constructor for the Index of Phonetic Complexity with specified scores for each component.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    C()
    Returns the value of the C record component.
    int
    D()
    Returns the value of the D record component.
    IndexOfPhoneticComplexity
    difference(IndexOfPhoneticComplexity other)
    Difference between two IndexOfPhoneticComplexity objects.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    String
    explanation()
    Returns the value of the explanation record component.
    static IndexOfPhoneticComplexity
    FromTranscript(IPATranscript ipa)
    Calculate the Index of Phonetic Complexity from an IPATranscript.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    L()
    Returns the value of the L record component.
    int
    M()
    Returns the value of the M record component.
    int
    P()
    Returns the value of the P record component.
    int
    S()
    Returns the value of the S record component.
    int
    T()
    Returns the value of the T record component.
    final String
    toString()
    Returns a string representation of this record class.
    int
    totalScore()
    Calculate the total score for the index of phonetic complexity.
    int
    V()
    Returns the value of the V record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • IndexOfPhoneticComplexity

      public IndexOfPhoneticComplexity()
      Default constructor for the Index of Phonetic Complexity. Zero scores for all components.

    • IndexOfPhoneticComplexity

      public IndexOfPhoneticComplexity(int D, int M, int V, int S, int L, int P, int C, int T, String explanation)
      Constructor for the Index of Phonetic Complexity with specified scores for each component.
      Parameters:
      D - Place score (dorsals)
      M - Manner score (fricatives, affricates, and liquids)
      V - Vowel score (rhotic vowels)
      S - Word shape score (ends with a consonant)
      L - Word length score (3 or more syllables)
      P - Place variegation score (singleton consonants that are place variegated)
      C - Contiguous clusters score
      T - Cluster type score (heterorganic clusters)

  • Method Details

    • FromTranscript

      public static IndexOfPhoneticComplexity FromTranscript(IPATranscript ipa)
      Calculate the Index of Phonetic Complexity from an IPATranscript.
      Parameters:
      ipa - the IPATranscript to calculate the index from
      Returns:
      an IndexOfPhoneticComplexity object representing the calculated index

    • totalScore

      public int totalScore()
      Calculate the total score for the index of phonetic complexity.
      Returns:
      the total score

    • difference

      public IndexOfPhoneticComplexity difference(IndexOfPhoneticComplexity other)
      Difference between two IndexOfPhoneticComplexity objects.
      Parameters:
      other - the other IndexOfPhoneticComplexity object
      Returns:
      a new IndexOfPhoneticComplexity object representing the difference

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • D

      public int D()
      Returns the value of the D record component.
      Returns:
      the value of the D record component

    • M

      public int M()
      Returns the value of the M record component.
      Returns:
      the value of the M record component

    • V

      public int V()
      Returns the value of the V record component.
      Returns:
      the value of the V record component

    • S

      public int S()
      Returns the value of the S record component.
      Returns:
      the value of the S record component

    • L

      public int L()
      Returns the value of the L record component.
      Returns:
      the value of the L record component

    • P

      public int P()
      Returns the value of the P record component.
      Returns:
      the value of the P record component

    • C

      public int C()
      Returns the value of the C record component.
      Returns:
      the value of the C record component

    • T

      public int T()
      Returns the value of the T record component.
      Returns:
      the value of the T record component

    • explanation

      public String explanation()
      Returns the value of the explanation record component.
      Returns:
      the value of the explanation record component