Quelltext der Seite Wikipedia:Lua/Modul/Expr/de

{{SeitenordnungWP.de
| PageID = 93515
| Obereinordnung1 = MW-Verwaltung
}}
{{LuaModuleDoc}}
<onlyinclude>'''<code>Expr</code>''' – Modul mit Funktionen für Ausdrücke in Ergänzung zu den von der Parser-Funktion <code>[[Hilfe:Parserfunktionen/Zahlen#expr|#expr]]</code> gebotenen Möglichkeiten.

Die Funktionsergebnisse sind dafür vorgesehen, als Terme innerhalb anderer Berechnungen verwendet zu werden. Sie haben deshalb keine Möglichkeit, Fehlersituationen über Meldungen oder Wartungskategorien zu kommunizieren.

== {{Anker|Vorlage}} Funktionen für Vorlagen ==
Die Standard-Funktionen richten sich an <code>#invoke</code> und dessen Parameter. Whitespace (etwa Leerzeichen oder Zeilenumbrüche) vor und nach den Werten wird ignoriert.

; average   {{Anker|average}}
: Durchschnitt berechnen
:* '''1''' – Erste Zahl
:* '''2''' – Zweite Zahl
:* '''parse''' – ''(optional)'' [[#parseExpr|Zahlenformat]] der Eingaben
:* '''3''' – ''(optional)'' Weitere Zahl
:* '''4''' usw. – ''(optional)'' Weitere Zahlen, beliebig viele
: Der Durchschnitt ist immer mindestens <code>0</code> und ungültige Werte werden ignoriert.
; base62   {{Anker|base62}}
: Kodierung und Dekodierung gemäß Base62 (das ist [[Base64]] ohne <code>+/</code>).
:* '''1''' – zu verarbeitender Wert
:* '''2''' – ''(optional)'' <code>D2B</code> für Dezimal-in-Base62; Vorgabe: Base62-in-Dezimal
; crossTotal   {{Anker|crossTotal}}
: Quersumme berechnen
:* '''1''' – Positive ganze Zahl, nur Ziffern (Minuszeichen und Nachkommastellen würden ignoriert)
: <code>0</code> wenn ungültig.
; decimal2minsec   {{Anker|decimal2minsec}}
: Koordinatenwert von Dezimaldarstellung in Grad-Minuten-Sekunden umrechnen
:* '''1''' – Dezimalzahl
:* '''2''' – ''(optional)'' Anzahl der Nachkommastellen der Sekunden (Vorgabe: keine)
:* '''parse''' – ''(optional)'' [[#parseExpr|Zahlenformat]] der Dezimalzahl
: Ergebnis: Umbruchgeschütztes <code>&lt;span></code>-Element mit Grad, Minuten, Sekunden, sonst&nbsp;<code>0</code>
; figure   {{Anker|figure}}
: Zahl auf Gültigkeit prüfen und ggf. konvertieren
:* '''1''' – Zahl
:* '''parse''' – ''(optional)'' [[#parseExpr|Zahlenformat]]
:* '''expr''' – ''(optional)'' <code>1</code> – Berechnungs-Ausdruck zulassen nach den Regeln der Parserfunktion <code>[[Hilfe:Parserfunktionen/Zahlen#expr|#expr]]</code>
:* '''set''' – ''(optional)'' Zahlenbereich; Bedingung muss erfüllt sein
:** <code>R</code> – ''(Vorgabe)'' Reelle Zahl (also beliebig)
:** <code>R+</code> – Zahl größer oder gleich Null; also nicht-negativ
:** <code>R-</code> – Zahl kleiner oder gleich Null; also nicht-positiv
:** <code>Z</code> – [[Ganze Zahl]] (wertmäßig)
:** <code>N</code> – [[Natürliche Zahl]] einschließlich Null; also nicht-negativ
:** <code>Z+</code> – identisch <code>N</code>
:** <code>Z-</code> – Ganze Zahl kleiner oder gleich Null; also nicht-positiv
: ''nichts'' falls ungültig
; max   {{Anker|max}}
: Maximum einer Menge von Zahlen ermitteln.
: Alle unbenannten Parameter werden zur Berechnung herangezogen.
:* Parameterwerte können leer sein oder Ausdrücke enthalten, die sich mit <code>#expr</code> auswerten lassen.
:* Es wird sowohl das übliche Minus-Ersatzzeichen [[Bindestrich-Minus|Bindestrich-Minus (U+002D)]] wie auch das typografische [[Minuszeichen|Minuszeichen (U+2212)]] akzeptiert [[#Unicode-Minuszeichen|(siehe unten)]].
:* Optionen sind in benannten Parametern möglich:
:** <code>minus</code> – Minuszeichen im Ergebnis; siehe [[#Unicode-Minus|unten]]
:** <code>zeroBlank=1</code> – Null als leeren Wert darstellen<ref>Der einzig zugesicherte Wert ist <code>1</code> für „ja, wahr“. Jede Angabe des Parameters hat zwar die gleiche Wirkung, ist aber unerwünscht.</ref>
<!-- |dec=,  |sep=. -->
: Der Rückgabewert ist eine leere Zeichenkette („nichts“), wenn kein Parameterwert oder nur leere Werte angegeben wurden; auch eine Fehlermeldung für ungültige <code>#expr</code> kann auftreten. Ansonsten die ermittelte Zahl in der spezifizierten Darstellung.
; min   {{Anker|min}}
: Minimum ermitteln; ansonsten genau analog [[#max|max]].
; minsec2decimal   {{Anker|minsec2decimal}}
: Koordinatenwert von Grad-Minuten-Sekunden in Dezimaldarstellung umrechnen
:* '''1''' – Grad
:* '''2''' – ''(optional)'' Minuten
:* '''3''' – ''(optional)'' Sekunden
:* '''4''' – ''(optional)'' Buchstabe für Himmelsrichtung
:* '''parse''' – ''(optional)'' [[#parseExpr|Zahlenformat]] der Eingaben
: <code>0</code> wenn ungültig.
; modulo   {{Anker|modulo}}
: [[Modulo]]
:* '''1''' – Zahlenwert (Dividend)
:* '''2''' – Ganzwert (Basis, Divisor, Bezugswert) Null unzulässig
:* '''3''' – ''(optional)'' [[#parseExpr|Zahlenformat]] der Eingaben
: <code>0</code> wenn ungültig.
; percent   {{Anker|percent}}
: Prozentsatz aus Prozentwert und Grundwert berechnen
:* '''1''' – Anteil
:* '''2''' – Grundwert (Basis, Bezugswert, 100 %) Null unzulässig
:* '''3''' – ''(optional)'' Zahl der Nachkommastellen (Vorgabe: keine)
:* '''4''' – ''(optional)'' schließende Nullen in den Nachkommastellen beibehalten
:* '''parse''' – ''(optional)'' [[#parseExpr|Zahlenformat]] der Eingaben
:* '''low''' – ''(optional)'' Ergebnis-Format, <code>1</code> für „Computer-Format“ (Vorgabe: lokales Wiki).
: Das Ergebnis schließt mit einem <code>%</code> ab und der Zahlenwert kann deshalb nicht selbst formatiert werden.
: <code>0</code> wenn ungültig.
; Ramanujan   {{Anker|Ramanujan}}
: Ellipsenumfang nach der Näherungsformel von Ramanujan
:* '''1''' – Große Halbachse (a) der Ellipse. Nur Zahlen zulässig
:* '''2''' – Exzentrizität (&epsilon;) der Ellipse. Wertebereich 0 &le; &epsilon; &lt; 1
: Das Ergebnis ist der nicht gerundete Wert.
: <code>-1</code> wenn ungültig.
; random   {{Anker|random}}
: (Pseudo-)Zufallszahl (ganzzahlig)
:* '''1''' – ''(optional)'' Basis, Normierung, Anzahl der Werte (Vorgabe: <code>100</code>), ganzzahlig >1.
: Ergebnisse sind ganzzahlig, beginnend bei einschließlich Null, größter Wert eins weniger als Anzahl.
: Jede Einbindung in der Seite liefert ein unabhängiges und deshalb meist unterschiedliches Ergebnis. Bei drei möglichen Werten und vier Einbindungen werden Wiederholungen allerdings unvermeidlich sein.
: ''seed''-Werte zur Sicherstellung unterschiedlicher Werte innerhalb der Seite  sind nicht erforderlich.
; sum   {{Anker|sum}}
: Summe berechnen
:* '''1''' – Erste Zahl
:* '''2''' – Zweite Zahl
:* '''parse''' – ''(optional)'' [[#parseExpr|Zahlenformat]] der Eingaben
:* '''3''' – ''(optional)'' Weitere Zahl
:* '''4''' usw. – ''(optional)'' Weitere Zahlen, beliebig viele
: Die Summe ist immer mindestens <code>0</code> und ungültige Werte werden ignoriert.
; failsafe   {{Anker|failsafe}}
: Versionsmanagement
{{Wikipedia:Lua/Modul-Failsafe|Modul=Expr}}

=== {{Anker|templatePars}} Direkteinbindung in Vorlagen ===
; TemplateAverage
: Wie [[#average|average]], jedoch alle Parameter der umgebenden Vorlage verwenden.
; TemplateBooland
: <code>1</code>, wenn alle Parameter „etwas“ sind, sonst „nichts“.<!-- faculty() -->
: Parameter der umgebenden Vorlage verwenden.
; TemplateBoolor
: <code>1</code>, wenn ein Parameter „etwas“ ist, sonst „nichts“.<!-- 0 faculty() -->
: Parameter der umgebenden Vorlage verwenden.
; TemplateMax
: Wie [[#max|max]], jedoch speziell für [[Vorlage:Max]] – alle Parameter der umgebenden Vorlage verwenden.
; TemplateMin
: Wie [[#min|min]], jedoch speziell für [[Vorlage:Min]] – alle Parameter der umgebenden Vorlage verwenden.
; TemplateSum
: Wie [[#sum|sum]], jedoch alle Parameter der umgebenden Vorlage verwenden.

=== {{Anker|Unicode-Minus}} Unicode-Minuszeichen ===
In den Eingabewerten kann sowohl das [[American Standard Code for Information Interchange|ASCII]]-Zeichen <code>-</code> auf der Tastatur ([[Bindestrich-Minus|U+002D]]) als auch das typografische Minuszeichen − ([[Minuszeichen|U+2212]]) verwendet werden. Mit dem Minuszeichen wird wie folgt verfahren:
* Enthält einer der Eingabewerte ein Unicode-Minus U+2212, wird dies auch im Ergebnis benutzt.
* Option <code>minus=1</code><br /> Ergebnis immer mit Unicode-Minus darstellen.<ref>Der einzig zugesicherte Wert ist <code>1</code> für „Unicode-Minus“. Jede Angabe des Parameters außer mit dem Wert <code>-</code> hat zwar die gleiche Wirkung, ist aber unerwünscht.</ref>
* Option <code>minus=-</code><br /> Ergebnis immer mit ASCII-Bindestrich-Minus darstellen.
Ein Ergebnis mit Unicode-Minuszeichen ist zwangsläufig immer eine [[Zeichenkette]].

=== Zahlenformat der Eingabe ===
{{#lst:Modul:Expr/Doku|parseSpec}}
<div style="clear:both"></div>

=== Beispiele (Testseite) ===
Eine [[Wikipedia:Lua/Modul/Expr/Test|Testseite]] illustriert praktische Beispiele.</onlyinclude>

== {{Anker|Lua}} Funktionen für Lua-Module ==

Viele der oben dokumentierten Funktionen können auch über <code>require()</code> in andere Module eingebunden werden:
<syntaxhighlight lang="lua">
local lucky, Expr = pcall( require, "Module:Expr" )
if type( Expr ) == "table" then
    Expr = Expr()
else
    -- Fehlerfall; Expr enthält Fehlermeldung
    return "<span class='error'>" .. Expr .. "</span>"
end
</syntaxhighlight>
Danach steht zur Verfügung:
; Expr.[[#average|average]]( array, ask )
:* <code>array</code> – sequence ''table'', mit ''string'' oder ''number''
:* <code>ask</code> – [[#parseExpr|Zahlenformat]] der Eingaben
: Ergebnis: ''number'', mindestens <code>0</code>
; Expr.[[#base62|base62]]( adjust )
:* <code>adjust</code> – ''string'' oder ''number''
:** ''number'' – kodiere in base62 (''string'')
:** ''string'' – dekodiere in ''number''
; Expr.[[#crossTotal|crossTotal]]( amount )
:* <code>amount</code> – ''string'' oder ''number''
: Ergebnis: ''number'', mit Quersumme des positiven ganzzahligen Teils, mindestens <code>0</code>
; Expr.[[#decimal2minsec|decimal2minsec]]( amount, align, ask )
:* <code>amount</code> – Dezimalzahl, ''string'' oder ''number''
:* <code>align</code> – Anzahl der Nachkommastellen der Sekunden, ''string'' oder ''number'' (Vorgabe:&nbsp;<code>0</code>)
:* <code>ask</code> – [[#parseExpr|Zahlenformat]] der Dezimalzahl
: Ergebnis: ''mw.html''-Objekt im Erfolgsfall, ''string''&nbsp;<code>0</code> sonst
; Expr.[[#figure|figure]]( amount, ask, advance, area )
:* <code>amount</code> – Zahl, ''string'' oder ''number''
:* <code>ask</code> – [[#parseExpr|Zahlenformat]]
:* <code>advance</code> – true: Ausdrücke
:* <code>area</code> – Zahlenbereich
: Ergebnis: ''number'', oder <code>false</code> wenn ungültig
; Expr.[[#minsec2decimal|minsec2decimal]]( aDeg, aMin, aSec, alter, ask )
:* <code>aDeg</code> – Gradzahl, ''string'' oder ''number''
:* <code>aMin</code> – Minutenzahl, ''string'' oder ''number'' oder nichts
:* <code>aSec</code> – Sekundenzahl, ''string'' oder ''number'' oder nichts
:* <code>alter</code> – Buchstabe für Himmelsrichtung, oder nichts
:* <code>ask</code> – [[#parseExpr|Zahlenformat]] der Eingaben
: Ergebnis: ''number'', <code>0</code> wenn ungültig
; Expr.[[#modulo|modulo]]( amount, adjust, ask )
:* <code>amount</code> – Zahl, ''string'' oder ''number''
:* <code>adjust</code> – Basis, ''string'' oder ''number''
:* <code>ask</code> – [[#parseExpr|Zahlenformat]] der Eingaben
: Ergebnis: ''number'', <code>0</code> wenn ungültig
; Expr.[[#percent|percent]]( amount, all, align, after, ask, allow, frame )
:* <code>amount</code> – Anteil, ''string'' oder ''number''
:* <code>all</code> – Basis (Bezugswert), ''string'' oder ''number''
:* <code>align</code> – Zahl der Nachkommastellen, ''string'' oder ''number'' (Vorgabe: keine)
:* <code>after</code> – <code>true</code>, um schließende Nullen in den Nachkommastellen beizubehalten
:* <code>ask</code> – [[#parseExpr|Zahlenformat]] der Eingaben
:* <code>allow</code> – Ergebnis-Format, <code>true</code>,  für „Computer-Format“ (Vorgabe: lokales Wiki).
:* <code>frame</code> – Objekt, falls zur Hand
: Das Ergebnis schließt mit einem <code>%</code> ab und der Zahlenwert kann deshalb nicht selbst formatiert werden.
: ''number'' <code>0</code> wenn ungültig
; Expr.[[#sum|sum]]( array, ask )
:* <code>array</code> – sequence ''table'', mit ''string'' oder ''number''
:* <code>ask</code> – [[#parseExpr|Zahlenformat]] der Eingaben
: Zwei Ergebnisse:
:# ''number'', mit Summe, mindestens <code>0</code>
:# ''number'', mit Anzahl gültiger Summanden, mindestens <code>0</code>
; Expr.[[#failsafe|failsafe]]( atleast )
: ''(wie oben)''

Als Rückgabewerte kommen ''number'', Zeichenketten oder <code>false</code> in Frage.

== Verwendung ==
Allgemeine Bibliothek; nicht eingegrenzt.
* [[Vorlage:%]]
* [[Vorlage:booland]]
* [[Vorlage:boolor]]
* [[Vorlage:Dezimalgrad]]
* [[Vorlage:Grad]]
* [[Vorlage:max]]
* [[Vorlage:min]]
* [[Vorlage:modulo]]
* [[Vorlage:NurWennZahl]]
* [[Vorlage:Quersumme]]
* [[Vorlage:Zufallszahl]]

== Abhängigkeiten ==
Keine.
<onlyinclude>
== Anmerkungen ==
<references /></onlyinclude>

== {{Anker|pipeline}} Implementierung in Vorbereitung ==
Die nachstehenden Funktionen sind teilweise bereits implementiert, jedoch noch nicht ausgetestet und nicht freigegeben.

; digitAt
: Ziffer aus einer Ganzzahl extrahieren
: [[Vorlage:Ziffer]]
; digitsAt
: Ziffern aus einer Ganzzahl extrahieren
: [[Vorlage:Ziffern]]
; IstZahl
: [[Vorlage:IstZahl]]
; isInList
: Ist es in der Liste?
: [[Vorlage:In Liste]]

[[Kategorie:Wikipedia:Lua/Modul/Dokumentation|Expr]]