MMT - info.kwarc.mmt.got.GraphOptimizationTool

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

def apply(modifier: BuildTargetModifier, arch: Archive, in: FilePath): Unit

the main function to run the build target

en empty in filepath addresses the whole archive

modifier: chooses build, clean, or update
arch: the archive to build on
in: the folder inside the archive's inDim folder to which building is restricted

Definition Classes: BuildTarget

final def asInstanceOf[T0]: T0

Definition Classes: Any

def build(a: Archive, up: Update, in: FilePath): Unit

build or update this target in a given archive

Definition Classes: GraphOptimizationTool → BuildTarget

def buildDepsFirst(a: Archive, up: Update, in: FilePath = EmptyPath): Unit

build estimated dependencies first

this can be used by the trivial build manager to build targets (like latexml) in dependency order provided that estimated dependencies are correct.

For a queue build manager this code is obsolete

Definition Classes: BuildTarget

def catchErrors[A](msg: String, recoverWith: ⇒ A)(code: ⇒ A): A

like its partner but with return value

Attributes: protected
Definition Classes: Extension

def catchErrors(msg: String)(code: ⇒ Unit): Unit

convenience method for wrapping code in error handler that throws LocalError

Attributes: protected
Definition Classes: Extension

def clean(a: Archive, in: FilePath): Unit

clean this target in a given archive

Definition Classes: GraphOptimizationTool → BuildTarget

def clone(): AnyRef

Attributes: protected[lang]
Definition Classes: AnyRef
Annotations: @throws( ... ) @native()

var command: String

val controller: Controller

the controller that this extension is added to; only valid after creation of the extension, i.e., will return null if used in a non-lazy val-field

Attributes: protected
Definition Classes: Extension

def convertToInclusionURIs(map: HashMap[MPath, HashMap[Path, HashSet[MPath]]]): HashMap[MPath, HashMap[Path, HashSet[MPath]]]

Attributes: protected

lazy val defaultPrefix: String

Definition Classes: Extension

def delete(f: File): Unit

auxiliary method for deleting a file

Attributes: protected
Definition Classes: BuildTarget

def destroy: Unit

extension-specific cleanup (override as needed, empty by default)

Extensions may create persistent data structures and threads, but they must clean up after themselves in this method

Definition Classes: Extension

def destroyWhenRemainingTasksFinished: Unit

convenience for calling waitUntilRemainingTasksFinished and then destroy

Definition Classes: Extension

val dialogue: Dialogue

def directIncludes(theoryPath: MPath, replacementmap: HashMap[MPath, HashMap[Path, HashSet[MPath]]]): HashSet[MPath]

Returns direct inclusions

This method returns a theory's direct inclusions by analyzing its content. It takes into account changes to the graph using replacementmap.

theoryPath: This is the path of the theory to be analyzed
replacementmap: This is a map containing inclusion replacements for each theory
returns: This is a list of all direct inclusions

Attributes: protected

final def eq(arg0: AnyRef): Boolean

Definition Classes: AnyRef

def equals(arg0: Any): Boolean

Definition Classes: AnyRef → Any

def finalize(): Unit

Attributes: protected[lang]
Definition Classes: AnyRef
Annotations: @throws( classOf[java.lang.Throwable] )

def findRedundantIncludes(theoryPath: MPath, replacementmap: HashMap[MPath, HashMap[Path, HashSet[MPath]]] = ...): List[Path]

Find simply redundant inclusions

This method finds inclusions that are redundant, since they are already part of a different inclusion

theoryPath: This is the path of the theory to be optimized
replacementmap: This is a map containing inclusion replacements for each theory
returns: This is a list containing the suggested removals for the theory

def findReplacements(interactive: Boolean = false): HashMap[MPath, HashMap[Path, HashSet[MPath]]]

Optimizes all known theories

This method optimizes all theories inside the onthology

returns: This is a map containing the suggested replacements for all analyzed theories

def findReplacements(theories: Iterable[MPath], interactive: Boolean): HashMap[MPath, HashMap[Path, HashSet[MPath]]]

Optimizes multiple theories

This method optimizes all given theories in the Iterable. Boolean toggle for interactive mode.

theories: Theories to be optimized as Iterable[MPath]
returns: This is a map containing the suggested replacements for all analyzed theories

def findUnusedIncludeReplacements(theoryPath: MPath, replacementmap: HashMap[MPath, HashMap[Path, HashSet[MPath]]] = ..., futureUse: HashMap[MPath, HashSet[MPath]] = ...): HashMap[Path, HashSet[MPath]]

Finds superfluous inclusions

This method optimizes a theory by reducing its inclusions to those used inside the theory

theoryPath: This is the path of the theory to be optimized
replacementmap: This is a map containing inclusion replacements for each theory
futureUse: This is a map containing used theories in the futureLite-code
returns: This is a map containing the suggested replacements for the theory

final def getClass(): Class[_]

Definition Classes: AnyRef → Any
Annotations: @native()

def getDependencies(mpath: MPath, replacementmap: HashMap[MPath, HashMap[Path, HashSet[MPath]]] = ...): HashSet[MPath]

Attributes: protected

def getFromFirstArgOrEnvvar(args: List[String], name: String, default: String = ""): String

Attributes: protected
Definition Classes: Extension

def hashCode(): Int

Definition Classes: AnyRef → Any
Annotations: @native()

var ignoreUnion: Boolean

def includes(theoryPath: MPath, replacementmap: HashMap[MPath, HashMap[Path, HashSet[MPath]]] = ...): HashSet[MPath]

Returns theory inclusions

This method returns a theory's inclusions, by looking at its direct inclusions and then being applied recursively to the included theories

theoryPath: This is the path of the theory to be analyzed
replacementmap: This is a map containing inclusion replacements for each theory
returns: This is a list of all inclusions, including indirect

Attributes: protected

def initOther(e: Extension): Unit

any extension can initialize other extensions if those are not meant to be added to the ExtensionManager

Attributes: protected
Definition Classes: Extension

def isApplicable(format: String): Boolean

format: the format/key/other identifier, for which an extension is needed
returns: true if this extension is applicable

Definition Classes: BuildTarget → FormatBasedExtension

final def isInstanceOf[T0]: Boolean

Definition Classes: Any

def key: String

a string identifying this build target, used for parsing commands, logging, error messages

Definition Classes: GraphOptimizationTool → BuildTarget

def log(e: Error): Unit

logs an error - always logged

Attributes: protected
Definition Classes: Logger

def log(s: ⇒ String, subgroup: Option[String] = None): Unit

logs a message with this logger's logprefix

Attributes: protected
Definition Classes: Logger

def logError(s: ⇒ String): Unit

log as an error message

Attributes: protected
Definition Classes: Logger

def logGroup[A](a: ⇒ A): A

wraps around a group to create nested logging

Attributes: protected
Definition Classes: Logger

def logPrefix: String

defaults to the key

Definition Classes: BuildTarget → Extension → Logger

def logTemp(s: ⇒ String): Unit

temporary logging - always logged

Attributes: protected
Definition Classes: Logger

def makeErrorThrower(msg: String): ErrorHandler

an ErrorHandler that wraps an error in a LocalError and throws it

Attributes: protected
Definition Classes: Extension

final def ne(arg0: AnyRef): Boolean

Definition Classes: AnyRef

final def notify(): Unit

Definition Classes: AnyRef
Annotations: @native()

final def notifyAll(): Unit

Definition Classes: AnyRef
Annotations: @native()

var predictFuture: Boolean

var printErrors: Boolean

var protectStructures: Boolean

def replaceInclusionToXML(map: HashMap[Path, HashSet[MPath]]): String

Converts replacement to xml

This method converts a given mapping of replacements for a single theory to an XML representation

map: This is a map containing inclusion replacements for one theory
returns: XML-String

Attributes: protected

def replaceTheoryToXML(theoryPath: MPath, map: HashMap[MPath, HashMap[Path, HashSet[MPath]]]): String

Xml conversion subroutine

This method is a subroutine of allToXML

map: This is a map containing inclusion replacements for each theory
returns: XML-String, or empty if mapping is

Attributes: protected

val report: Report

Attributes: protected
Definition Classes: Extension → Logger

def sortTheories(theories: Iterable[MPath], map: HashMap[MPath, HashMap[Path, HashSet[MPath]]]): List[MPath]

Sorts theories

Sort theories in topological order, with innermost theories coming first.

theories: This is an Iterable of theories to be sorted
returns: This is a sorted List of theories

Attributes: protected

def start(args: List[String]): Unit

extension-specific initialization (override as needed, empty by default)

Definition Classes: Extension

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

Definition Classes: AnyRef

def toString(): String

Definition Classes: BuildTarget → AnyRef → Any

def toXML(map: HashMap[MPath, HashMap[Path, HashSet[MPath]]]): String

Converts map to xml

This method converts a given mapping as generated by findReplacements to an XML representation

map: This is a map containing inclusion replacements for each theory
returns: XML-String

def transitiveClosure(theories: HashSet[MPath]): HashSet[MPath]

Attributes: protected

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( ... ) @native()

def waitUntilRemainingTasksFinished: Unit

extensions that process tasks in separate threads should override this and wait until those threads are done

Definition Classes: Extension

object FindUsedTheories extends Traverser[HashSet[MPath]]

Traverser finding used theories

This object is a traverser and searches a theory for all theories that are used

Attributes: protected

Packages

GraphOptimizationTool

class GraphOptimizationTool extends BuildTarget

Instance Constructors

Type Members

Value Members

Inherited from BuildTarget

Inherited from FormatBasedExtension

Inherited from Extension

Inherited from Logger

Inherited from AnyRef

Inherited from Any

Ungrouped