Class EntropyCalculator

constructor

• new EntropyCalculator(options?): EntropyCalculator

• Parameters

  • Optional options: HarmonicEntropyOptions

  Returns EntropyCalculator

table

N

• get N(): number

• Max height of rationals (Benedetti or Wilson depending on series)

  Returns number
• set N(value): void

• Parameters

  • value: number

  Returns void

a

• get a(): number

• Rényi order

  Returns number
• set a(value): void

• Parameters

  • value: number

  Returns void

maxCents

• get maxCents(): number

• Upper bound of tabulation

  Returns number
• set maxCents(value): void

• Parameters

  • value: number

  Returns void

minCents

• get minCents(): number

• Lower bound of tabulation

  Returns number
• set minCents(value): void

• Parameters

  • value: number

  Returns void

normalize

• get normalize(): boolean

• Boolean flag to normalize the result by Hartley entropy

  Returns boolean
• set normalize(value): void

• Parameters

  • value: boolean

  Returns void

options

• get options(): HarmonicEntropyOptions

• Options associated with this harmonic entropy calculator.

  Returns HarmonicEntropyOptions
• set options(value): void

• Parameters

  • value: HarmonicEntropyOptions

  Returns void

res

• get res(): number

• Tabulation delta in cents

  Returns number
• set res(value): void

• Parameters

  • value: number

  Returns void

s

• get s(): number

• Gaussian frequency deviation (default 0.01)

  Returns number
• set s(value): void

• Parameters

  • value: number

  Returns void

series

• get series(): "tenney" | "farey"

• Series of rationals to use

  Returns "tenney" | "farey"
• set series(value): void

• Parameters

  • value: "tenney" | "farey"

  Returns void

ofCents

• ofCents(cents): number

• Calculate the harmonic entropy of a musical interval measured in cents.

  Parameters

  • cents: number

    Width of the interval.

  Returns number

  The harmonic entropy of the input in natural units.

  Throws

  An error if the input is outside the range of .minCents and .maxCents.

ofFraction

• ofFraction(value): number

• Calculate the harmonic entropy of a rational number.

  Parameters

  • value: FractionValue

    Fractional value.

  Returns number

  The harmonic entropy of the input in natural units.

  Throws

  An error if the input is outside of the tablated range.

toJSON

• toJSON(): {
      options: HarmonicEntropyOptions;
      tableY: number[];
      type: string;
  }

• Serialize the entropy calculator to a JSON compatible object.

  Returns {
      options: HarmonicEntropyOptions;
      tableY: number[];
      type: string;
  }

  The serialized object with property type set to 'EntropyCalculator'.

  • options: HarmonicEntropyOptions

  • tableY: number[]

  • type: string

Static reviver

• reviver(key, value): any

• Revive a EntropyCalculator instance produced by EntropyCalculator.toJSON(). Return everything else as is.

  Intended usage:

  const data = JSON.parse(serializedData, EntropyCalculator.reviver);
  Copy

  Parameters

  • key: string

    Property name.
  • value: any

    Property value.

  Returns any

  Deserialized EntropyCalculator instance or other data without modifications.