ReadAlign for Kotlin/fm.apakabar.readalign/Rules

Rules

@Serializable

data class Rules(val matchThreshold: Double, val joinFloor: Double, val gapPenalty: Double, val mismatchPenalty: Double, val roomEnough: Double, val joinSpan: Int, val vouchedJoinSpan: Int, val englishVowels: String, val silentEnding: String, val silentEndingExceptAfter: String, val shortestWithASilentEnding: Int, val lightestWord: Double, val liftedMarksFrom: String, val liftedMarksTo: String, val letterJoiners: List<String>, val foldedLetters: Map<String, String>, val frameSeconds: Double, val roomQuantile: Double, val speechAboveRoom: Double, val quietestRoom: Double, val holdLimit: Double, val leastWidening: Double, val speechFromLoudestShare: Double, val quietestSpeech: Double, val pieceSeconds: Double, val shortestPieceShare: Double, val pauseSeconds: Double, val edgeOverlap: Double, val askAgainTrims: List<Double>, val shortestWorthAskingAgain: Double, val uncoveredHeadSeconds: Double, val partialAnswerOverlap: Double)(source)

The numbers the alignment is tuned to. What each is for is written beside it in rules.yaml.

Constructors

constructor(matchThreshold: Double, joinFloor: Double, gapPenalty: Double, mismatchPenalty: Double, roomEnough: Double, joinSpan: Int, vouchedJoinSpan: Int, englishVowels: String, silentEnding: String, silentEndingExceptAfter: String, shortestWithASilentEnding: Int, lightestWord: Double, liftedMarksFrom: String, liftedMarksTo: String, letterJoiners: List<String>, foldedLetters: Map<String, String>, frameSeconds: Double, roomQuantile: Double, speechAboveRoom: Double, quietestRoom: Double, holdLimit: Double, leastWidening: Double, speechFromLoudestShare: Double, quietestSpeech: Double, pieceSeconds: Double, shortestPieceShare: Double, pauseSeconds: Double, edgeOverlap: Double, askAgainTrims: List<Double>, shortestWorthAskingAgain: Double, uncoveredHeadSeconds: Double, partialAnswerOverlap: Double)

Types

object Companion

Properties

@SerialName(value = "ask_again_trims")

val askAgainTrims: List<Double>

@SerialName(value = "edge_overlap")

val edgeOverlap: Double

@SerialName(value = "english_vowels")

val englishVowels: String

@SerialName(value = "folded_letters")

val foldedLetters: Map<String, String>

@SerialName(value = "frame_seconds")

val frameSeconds: Double

@SerialName(value = "gap_penalty")

val gapPenalty: Double

@SerialName(value = "hold_limit")

val holdLimit: Double

@SerialName(value = "join_floor")

val joinFloor: Double

@SerialName(value = "join_span")

val joinSpan: Int

@SerialName(value = "least_widening")

val leastWidening: Double

@SerialName(value = "letter_joiners")

val letterJoiners: List<String>

liftedMarksFrom

@SerialName(value = "lifted_marks_from")

val liftedMarksFrom: String

@SerialName(value = "lifted_marks_to")

val liftedMarksTo: String

@SerialName(value = "lightest_word")

val lightestWord: Double

@SerialName(value = "match_threshold")

val matchThreshold: Double

mismatchPenalty

@SerialName(value = "mismatch_penalty")

val mismatchPenalty: Double

partialAnswerOverlap

@SerialName(value = "partial_answer_overlap")

val partialAnswerOverlap: Double

@SerialName(value = "pause_seconds")

val pauseSeconds: Double

@SerialName(value = "piece_seconds")

val pieceSeconds: Double

@SerialName(value = "quietest_room")

val quietestRoom: Double

@SerialName(value = "quietest_speech")

val quietestSpeech: Double

@SerialName(value = "room_enough")

val roomEnough: Double

@SerialName(value = "room_quantile")

val roomQuantile: Double

shortestPieceShare

@SerialName(value = "shortest_piece_share")

val shortestPieceShare: Double

shortestWithASilentEnding

@SerialName(value = "shortest_with_a_silent_ending")

val shortestWithASilentEnding: Int

shortestWorthAskingAgain

@SerialName(value = "shortest_worth_asking_again")

val shortestWorthAskingAgain: Double

@SerialName(value = "silent_ending")

val silentEnding: String

silentEndingExceptAfter

@SerialName(value = "silent_ending_except_after")

val silentEndingExceptAfter: String

speechAboveRoom

@SerialName(value = "speech_above_room")

val speechAboveRoom: Double

speechFromLoudestShare

@SerialName(value = "speech_from_loudest_share")

val speechFromLoudestShare: Double

uncoveredHeadSeconds

@SerialName(value = "uncovered_head_seconds")

val uncoveredHeadSeconds: Double

vouchedJoinSpan

@SerialName(value = "vouched_join_span")

val vouchedJoinSpan: Int

Functions

fun joins(code: Int): Boolean

Whether this mark writes one consonant joined to the next, making them one letter.

fun lifts(code: Int): Boolean

Whether this is one of the marks likeness is measured without.