BestFirstSearch

Instance Constructors

new BestFirstSearch(formatOps: FormatOps, range: Set[Range], formatWriter: FormatWriter)

Type Members

type StateHash = Long

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val MaxDepth: Int
val MaxEscapes: Int
val MaxVisitsPerToken: Int

Visit the same formatToken at most MaxVisitsPerToken times.
Visit the same formatToken at most MaxVisitsPerToken times.
If the same token is
val acceptOptimalAtHints: Boolean

Whether to listen to optimalAt fields in Splits.
final def asInstanceOf[T0]: T0

Definition Classes
Any
val best: Map[Token, State]
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
var deepestYet: State
var deepestYetSafe: State
val dequeueOnNewStatements: Boolean

When entering a new statement, clear out search queue.
val disableOptimizationsInsideSensitiveAreas: Boolean

Do not optimize inside certain areas such as term apply.
val doOptimizations: Boolean
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val escapeInPathologicalCases: Boolean

Use heuristics to escape when the search state grows out of bounds.
Use heuristics to escape when the search state grows out of bounds.
An optimization that trades off optimal formatting output in order to complete in a reasonable time. Used as a last resort.
var explored: Int
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
val formatOps: FormatOps
def getBestPath: Vector[Split]
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getLeftLeft(curr: State): Token
def hasReachedEof(state: State): Boolean
def hashCode(): Int

Definition Classes
AnyRef → Any
def isInsideNoOptZone(token: FormatToken): Boolean
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val maxVisitStates: Int
val memo: Map[(Int, StateHash), State]
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val noOptimizations: Set[Token]
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
var pathologicalEscapes: Int
def provided(formatToken: FormatToken): Split
val pruneSlowStates: Boolean

Eliminate solutions that move slower than other solutions.
Eliminate solutions that move slower than other solutions.
If a solution reaches a point X first and other solution that reaches the same point later, the first solution is preferred if it can be verified to be always better (see State.alwaysBetter()).
Note. This affects the output positively because it breaks a tie between two equally expensive solutions by eliminating the slower one.
Example, solution 1 is preferred even though both solutions cost the same:
// solution 1 a + b + c + d // solution 2 a + b + c + d
val recurseOnBlocks: Boolean

Recursively format { ...
Recursively format { ... } blocks inside no optimization zones.
By starting a new search queue, we can perform aggressive optimizations inside optimizations zones.
val router: Router
def shortestPath(start: State, stop: Token, depth: Int = 0, maxCost: Int = Integer.MAX_VALUE)(implicit line: Line): State

Runs best first search to find lowest penalty split.
def shortestPathMemo(start: State, stop: Token, depth: Int, maxCost: Int)(implicit line: Line): State
def shouldEnterState(curr: State): Boolean

Returns true if it's OK to skip over state.
def shouldRecurseOnBlock(curr: State, stop: Token): Boolean
def stateColumnKey(state: State): StateHash
var statementCount: Int
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def untilNextStatement(state: State): State
val visits: Map[FormatToken, Int]
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package internal

class BestFirstSearch extends AnyRef

Instance Constructors

new BestFirstSearch(formatOps: FormatOps, range: Set[Range], formatWriter: FormatWriter)

Type Members

type StateHash = Long

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val MaxDepth: Int

val MaxEscapes: Int

val MaxVisitsPerToken: Int

val acceptOptimalAtHints: Boolean

final def asInstanceOf[T0]: T0

val best: Map[Token, State]

def clone(): AnyRef

var deepestYet: State

var deepestYetSafe: State

val dequeueOnNewStatements: Boolean

val disableOptimizationsInsideSensitiveAreas: Boolean

val doOptimizations: Boolean

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

val escapeInPathologicalCases: Boolean

var explored: Int

def finalize(): Unit

val formatOps: FormatOps

def getBestPath: Vector[Split]

final def getClass(): Class[_]

def getLeftLeft(curr: State): Token

def hasReachedEof(state: State): Boolean

def hashCode(): Int

def isInsideNoOptZone(token: FormatToken): Boolean

final def isInstanceOf[T0]: Boolean

val maxVisitStates: Int

val memo: Map[(Int, StateHash), State]

final def ne(arg0: AnyRef): Boolean

val noOptimizations: Set[Token]

final def notify(): Unit

final def notifyAll(): Unit

var pathologicalEscapes: Int

def provided(formatToken: FormatToken): Split

val pruneSlowStates: Boolean

val recurseOnBlocks: Boolean

val router: Router

def shortestPath(start: State, stop: Token, depth: Int = 0, maxCost: Int = Integer.MAX_VALUE)(implicit line: Line): State

def shortestPathMemo(start: State, stop: Token, depth: Int, maxCost: Int)(implicit line: Line): State

def shouldEnterState(curr: State): Boolean

def shouldRecurseOnBlock(curr: State, stop: Token): Boolean

def stateColumnKey(state: State): StateHash

var statementCount: Int

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

def untilNextStatement(state: State): State

val visits: Map[FormatToken, Int]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped