Record Class LinguisticSystem.CorpusProfile

java.lang.Object
java.lang.Record
org.episteme.social.linguistics.LinguisticSystem.CorpusProfile
Enclosing class:
LinguisticSystem
public static record LinguisticSystem.CorpusProfile(String name, long documentCount, long totalTokens, long vocabularySize, double lexicalDiversity, double entropy) extends Record
Conducts a full statistical profile of a corpus. Includes TTR, entropy, and vocabulary insights.
Since:
1.0
Author:
Silvere Martin-Michiellot, Gemini AI (Google DeepMind)

  • Constructor Summary

    Constructors
    Constructor
    Description
    CorpusProfile(String name, long documentCount, long totalTokens, long vocabularySize, double lexicalDiversity, double entropy)
    Creates an instance of a CorpusProfile record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    documentCount()
    Returns the value of the documentCount record component.
    double
    entropy()
    Returns the value of the entropy record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    double
    lexicalDiversity()
    Returns the value of the lexicalDiversity record component.
    String
    name()
    Returns the value of the name record component.
    final String
    toString()
    Returns a string representation of this record class.
    long
    totalTokens()
    Returns the value of the totalTokens record component.
    long
    vocabularySize()
    Returns the value of the vocabularySize record component.

    Methods inherited from class Object

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

  • Constructor Details

    • CorpusProfile

      public CorpusProfile(String name, long documentCount, long totalTokens, long vocabularySize, double lexicalDiversity, double entropy)
      Creates an instance of a CorpusProfile record class.
      Parameters:
      name - the value for the name record component
      documentCount - the value for the documentCount record component
      totalTokens - the value for the totalTokens record component
      vocabularySize - the value for the vocabularySize record component
      lexicalDiversity - the value for the lexicalDiversity record component
      entropy - the value for the entropy record component

  • Method Details

    • 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.

    • name

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

    • documentCount

      public long documentCount()
      Returns the value of the documentCount record component.
      Returns:
      the value of the documentCount record component

    • totalTokens

      public long totalTokens()
      Returns the value of the totalTokens record component.
      Returns:
      the value of the totalTokens record component

    • vocabularySize

      public long vocabularySize()
      Returns the value of the vocabularySize record component.
      Returns:
      the value of the vocabularySize record component

    • lexicalDiversity

      public double lexicalDiversity()
      Returns the value of the lexicalDiversity record component.
      Returns:
      the value of the lexicalDiversity record component

    • entropy

      public double entropy()
      Returns the value of the entropy record component.
      Returns:
      the value of the entropy record component