content: /**
   * Copyright 2020 Alexander Herzog
   *
   * Licensed under the Apache License, Version 2.0 (the "License");
   * you may not use this file except in compliance with the License.
   * You may obtain a copy of the License at
   *
   * http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  package parser;
  
  /**
   * Interface welche die nach auen sichtbaren Funktionen
   * eines Parsers fr mathematische Ausdrcke auflistet.
   * Konkrete Parser mssen dieses Interface implementieren.
   * Anwendungen knnen dieses Interface nutzen, um von der
   * konkreten Implementierung des Parsers unabhngig zu sein.
   * @author Alexander Herzog
   * @see CalcSystemBase
   * @version 2.0
   */
  public interface MathParser {
  
  	/**
  	 * Versucht den bergebenen bergebenen Ausdruck zu interpretieren, dabei werden
  	 * Variablennamen erkannt usw., es wird aber noch kein konkreter Wert berechnet.
  	 * @param text	Ausdruck, der verarbeitet werden soll
  	 * @return	Gibt <code>-1</code> zurck, wenn der Ausdruck verarbeitet werden konnte.
  	 */
  	int parse(String text);
  
  	/**
  	 * Versucht den im Konstruktor bergebenen Ausdruck zu interpretieren, dabei werden
  	 * Variablennamen erkannt usw., es wird aber noch kein konkreter Wert berechnet.
  	 * @return	Gibt <code>-1</code> zurck, wenn der Ausdruck verarbeitet werden konnte.
  	 */
  	int parse();
  
  	/**
  	 * Berechnet den bereits geparsten Ausdruck auf Basis der bekannten Variablennamen und der hier angegebenen Werte.
  	 * @param variableValues	Liste mit den Werten der Variablen
  	 * @return	Zahlenwert des Ergebnisses.
  	 * @throws  MathCalcError	Fehler whrend der Berechnung
  	 */
  	double calc(double[] variableValues) throws MathCalcError;
  
  	/**
  	 * Berechnet den bereits geparsten Ausdruck auf Basis der bekannten Variablennamen und der hier angegebenen Werte.
  	 * @param	variableValues	Liste mit den Werten der Variablen
  	 * @param	fallbackValue	Wert, der zurckgegeben werden soll, wenn der Ausdruck nicht berechnet werden konnte
  	 * @return	Berechneter Wert oder im Fehlerfall der Vorgabewert
  	 */
  	double calcOrDefault(double[] variableValues, double fallbackValue);
  
  	/**
  	 * Berechnet den bereits geparsten Ausdruck auf Basis der bekannten Variablennamen und Werte.
  	 * @return	Zahlenwert des Ergebnisses.
  	 * @throws	MathCalcError	Fehler whrend der Berechnung
  	 */
  	double calc() throws MathCalcError;
  
  	/**
  	 * Gibt an, ob sich die Formel auf eine konstante Zahl reduzieren lsst (also keine Variablen enthlt).
  	 * @return Gibt <code>true</code> zurck, wenn es sich um eine konstante Zahl handelt.
  	 */
  	boolean isConstValue();
  
  	/**
  	 * Handelt es sich bei der Formel um eine konstante Zahl, so kann diese ber diese Methode abgefragt werden.
  	 * @return	Konstanter Wert der Formel
  	 * @see #isConstValue()
  	 */
  	double getConstValue();
  }