Package jline.io

Class InputOutput

java.lang.Object

jline.io.InputOutput

public final class InputOutput
extends Object

Method Summary

Modifier and Type	Method	Description
static void	line_ack(VerboseLevel verbose, String toolName)
static String	line_citation(String toolName)	Return the BibTeX entry for the canonical paper of an external tool that a wrapper solver delegates to, so that the acknowledgement printed by line_ack(VerboseLevel, String) can be turned into a citation without retyping it.
static void	line_debug(VerboseLevel verbose, String message)	Print debug message if verbose level is DEBUG
static void	line_error(String caller, String msg)
static void	line_warning(String caller, String msg, Object... args)
static void	line_warning_always(String caller, String msg, Object... args)	Emit a warning without the repeat suppression applied by line_warning(java.lang.String, java.lang.String, java.lang.Object...).
static String	lineStart()	Prints the LINE startup banner, as MATLAB's lineStart and python's line_solver.lineStart do.
static String	mfilename(Object obj)
static void	writeXML(String outputFileName, Document doc)	Writes the given XML Document object to a specified output file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

line_debug

public static void line_debug(VerboseLevel verbose,
 String message)

Print debug message if verbose level is DEBUG

line_warning_always

public static void line_warning_always(String caller,
 String msg,
 Object... args)

Emit a warning without the repeat suppression applied by line_warning(java.lang.String, java.lang.String, java.lang.Object...).

line_warning keeps only the last message and hides an identical repeat for 60 seconds. That is right for configuration notices cast once per model, but wrong for a warning that reports a correctness limitation of the analysis: solving several models in one session would then flag only the first one, and the user would read the silence on the others as a clean bill of health. Warnings that say "these numbers are not exact" must be raised for every model they apply to, so they go through here instead. Verbosity gating is unchanged: SILENT still silences everything.

line_warning

public static void line_warning(String caller,
 String msg,
 Object... args)

line_error

public static void line_error(String caller,
 String msg)

lineStart

public static String lineStart()

Prints the LINE startup banner, as MATLAB's lineStart and python's line_solver.lineStart do.

Using the JAR as a library stays silent otherwise, so this is the explicit entry point for a session banner. It also names where to obtain the third-party dependencies and the algorithm references: attribution in LINE is pull-based, in the spirit of Sage, so nothing is printed during a solve.

Returns:

the LINE version string

line_ack

public static void line_ack(VerboseLevel verbose,
 String toolName)

line_citation

public static String line_citation(String toolName)

Return the BibTeX entry for the canonical paper of an external tool that a wrapper solver delegates to, so that the acknowledgement printed by line_ack(VerboseLevel, String) can be turned into a citation without retyping it.

The keys match doc/latex/biblio.bib and BIBLIOGRAPHY.md. Mirror any edit in matlab/src/io/line_citation.m and line_solver.api.io.logging.line_citation.

Parameters:

toolName - the external tool, "JMT", "LQNS" or "QNS" ("QNS" shares the LQNS reference, qnsolver being part of that distribution)

Returns:

the BibTeX entry, or the empty string for an unknown tool

mfilename

public static String mfilename(Object obj)

writeXML

public static void writeXML(String outputFileName,
 Document doc)
                     throws TransformerException

Writes the given XML Document object to a specified output file.

Throws:

TransformerException