Wikifunctions:Suggest a function

Do you have an idea for a new function? Suggest it here! It may help to refer to our glossary.

You can go and create a function right away if you have the user-rights, and it aligns with other work.

Note that for now we only support strings, Booleans, Natural numbers, and lists as input and output types of functions. More types are coming in the next few months.

Once created, consider adding new Functions to the catalogue.

• remove stereochemical specificity in SMILES string
  • e/z isomers
• simplify SMILES string according to some basic simplifications

• Unicode normalising functions (there are several types of normalisation)
• Backslash-U with delimiters ASCII encoding of Unicode encode
  • Can someone elaborate on this? No example cases were given on the document, and backslash-U with delimiters is anyway not that prevalent as far as I have seen. BrightSunMan (talk) 15:24, 26 December 2023 (UTC)[reply]
• Backslash-U with delimiters ASCII encoding of Unicode decode
• XML and HTML ASCII encoding of Unicode encode
• XML and HTML ASCII encoding of Unicode decode
• HTML named character encode]
• Punycode encode - Punycode encode (Z10178) (part only, not whole url); see also IDNA encode (Z10185)
• Punycode decode - Punycode decode (Z10181) (part only, not whole url); see also IDNA decode (Z10188)
• Unified English Braille encode (discarding invalid characters?)
• Unified English Braille decode

• add locale-specific quotation marks to string
  • Shouldn't the output depend on the locale? See mw.language:formatNum. —Dexxor (talk) 17:15, 4 September 2023 (UTC)[reply]

• complementary colour in RGB colour model ("#FF0000" ⇒ "#00FFFF")
  • Any specification on invalid inputs? MilkyDefer 11:22, 5 August 2023 (UTC)[reply]

  Great question. I don't think there is a position documented on Wikifunctions for how to handle invalid input to a function. Can we throw exceptions? Return null? Dhx1 (talk) 13:23, 6 August 2023 (UTC)[reply]

  This shouldn't be a string function. This should be a type that represents a RGB color (with corresponding validation function (hopefully it can just be three unsigned 8bit integers)) and a function that returns the complementary color. 0xDeadbeef (talk) 12:38, 7 August 2023 (UTC)[reply]

• convert X11 color to hex (Z17713)

• check if string is an en:International_Chemical_Identifier
• check if string is a SMILES arbitrary target specification (SMARTS) notation
• check if string is an ABC notation
• check if string is a LilyPond notation
• Doing... check if string is a portable game notation for a chess game (is portable game notation (Z15867), figuring out how to add newlines to the test input)
• is Forsyth–Edwards Notation (Z14643) check if string is Forsyth–Edwards Notation for a chess position
• check if string is a UIC classification of locomotive axle arrangements notation
• check if a string is a valid ISBN-13 (probably just a simple variant of is EAN (Z10821), dropping/validating the hyphens)
• check if a string is a valid DOI
  • Something about implementation difficulties: https://stackoverflow.com/questions/27910/finding-a-doi-in-a-document-or-page Alexander-Mart-Earth (talk) 14:28, 21 December 2023 (UTC)[reply]
• check if a string is a valid ISWN

• Doing... check if string is in lower camel case
• check if string is a valid ISO 3166 country code
• check if string is a valid ISO 8601 date/time (2023-08-03 ⇒ true; 2023-02-30 ⇒ false; 2023-08-03 15:00:00.000 ⇒ true; 2023-08-03 25:00:00.000 ⇒ false)
• check if string is a valid EDTF date/time
• Doing... check if string is a valid email address (watch out, see this list of falsehoods about email addresses to create unit tests - email addresses are more complicated than they seem) — is valid email address (Z10410) creating test cases in progress. Currently it is stuck on figuring out what exactly is a valid emaill address. Nearly every errata for RFC:3696 is about that.
• Doing... check if string is a valid Wikidata item — Is valid Qid (Z10696) (possibly stuck on phab:T343593?)
• check if string is a valid ISO 6709 coordinates

...

• rectified linear unit (ReLU) - https://www.wikifunctions.org/view/en/Z13909

• is void (Z17180): check if an object (usually the result of a function) is void

• group

• zip lists together: for [ A .. Z ] and [ 1 .. 26 ] return [ [ A, 1 ], [ B, 2 ], .. ]
  • Unsure what happens if input lists are of different lengths.
  • If possible this function should be able to zip more than 2 lists together... 3, 4, n? Perhaps the input should be list(list, list, list, list, ..).

• list of strings to csv

number -> list of decimal digits
number -> list of binary digits
number -> list of digits in base provided Well very well (talk) 11:20, 18 May 2024 (UTC)[reply]

• sort, by a given function
• test whether certain functions have specific properties of homogeneous relations for particular lists/sets
• remove first element matching filter from list

morphology is the part of linguistics that studies how language parts are 'shaped' and change diachronically and when inflected. Hausa, Igbo, Malayalam, Bangla/Bengali and Dagbani are focus languages for Wikidata's lexicographic dataset, which is an important aspect of Abstract Wikipedia.

• inputs: natural number (new numeric type) and language Z-number; output: 'singular', 'dual', 'paucal', 'plural', etc. as string

  Doing...: use Z15977 instead (Z13899)

• string: Stokoe to ase-Sgnw and vice-versa (consult @Slevinski: as to best approach)

w:en:colloquial Welsh morphology

• tense * person * number for each verb
  • tenses: present, past, ...?
  • person: first, second, third
  • number: singular, plural
  • Doing... third person singular present
  • second person singular preterite

• English verb to agent noun (Z11390) Verb -> agent noun, e.g. "dance"->"dancer"
• Join English morphemes (extends suffix English word (Z13254) to cases like re + en + able + er + s → re-enablers. suffix English word (Z13254) will correctly join re-enable + ers or re- + enablers, but re + enablers → “renablers” (incorrect). English morpheme agglutination (Z13275) tests the Reduce function to produce “detoxification” from a list of four morphemes (orchestrator limit exceeded with five). I doubt we’ll want to derive “toxify” from “toxic”, however.
• Derive lemmas from a form. This is envisaged as the converse of Join English morphemes. The focus would be identifying the base form (the lexeme’s lemma) rather than further segmenting the lemma. For example, “underlay” should return “underlie” (for which it is the past participle) and the noun “underlay” (for which it is the lemma) and (perhaps) the verb “underlay”, which might be the tendency of an unproductive hen or the activity of a carpet-fitter. As this is a purely functional converse, every string will have itself as a possible lemma.
• Generate Numerical prefixes of various kinds from a natural number input.

• French masculine adjective to feminine (Z11590) Masculine adjective -> feminine, e.g. "exact"->"exacte"
• Conjugated verb => Infinitive, e.g. "alla" => "aller", "mordit" => "mordre"

A notated demo sentence ("Aishà taa jeefar dà kàren Indoo" ― "Aisha threw away Indo's dog") is available at http://intent.xigt.org

section moved to WF:human languages/Z1882

Note these functions cannot be implemented properly until the needed types are requested and approved.

If one wishes to nevertheless attempt to define and implement them,

• the functions and implementations should indicate prominently in their labels that their input/output types must be adjusted once support for the appropriate replacement types become available; and
• the functions should not be used in the implementations of any other functions, as the later adjustment of input/output types to appropriate replacements will break those implementations.

• count distance between two letters in given alphabet (default to 26-charcater western alphabet. case insensitive. e.g. "a" & "A" ⇒ 0; "K" & "N" ⇒ 3)
• Done Hamming distance between two strings of equal length, e.g. "Wikipedia" & "Wikimedia" ⇒ 1. - hamming distance between two strings (Z11328)
• Done Levenshtein distance between two strings (e.g. "kitten" to "sitting" => 3 : kitten > sitten > sittin > sitting) - Levenshtein Distance (Z10393)

(would be better with types representing a stream of bytes)

• Done BASE16 encode - Base16 Encode (Z11003)
• Done BASE16 decode - Base16 Decode (Z11007)
• Done BASE32 encode - Base32 Encode (Z14189)
• Done BASE32 decode - Base32 Decode (Z14195)
• BASE45 encode
• BASE45 decode
• Done BASE64 encode - Base64 Encode (Z10057)
• Done BASE64 decode - Base64 decode (Z10062)
• Hexadecimal UTF-8 encode ("ABC ₤" ⇒ "41 42 43 20 E2 82 A4")
• Hexadecimal UTF-8 decode ("41 42 43 20 E2 82 A4" ⇒ "ABC ₤")
• Decimal UTF-8 encode ("ABC ₤" ⇒ "65 66 67 32 226 130 164")
• Decimal UTF-8 decode ("65 66 67 32 226 130 164" ⇒ "ABC ₤")
• Octal UTF-8 encode ("ABC ₤" ⇒ "101 102 103 40 342 202 244")
• Octal UTF-8 decode ("101 102 103 40 342 202 244" ⇒ "ABC ₤")
• Binary UTF-8 encode ("ABC ₤" ⇒ "01000001 01000010 01000011 00100000 11100010 10000010 10100100")
• Binary UTF-8 decode ("01000001 01000010 01000011 00100000 11100010 10000010 10100100" ⇒ "ABC ₤")
• Unicode code point encode ("ABC ₤" ⇒ "41 42 43 20 20A4") - Unicode code point encode hex (Z10785)
• Unicode code point decode ("41 42 43 20 20A4" ⇒ "ABC ₤")
• Done chr of codepoint (Z11534) Unicode code point decimal decode - single character ("65" ⇒ "A")
• Create regular expression object/string (i.e: "test" & "i" to /test/i)

• Choose singular or plural based on number (e.g. singularOrPlural("person",6") -> "people")
  • Note that there are also dual and other grammatical numbers in other languages. 魔琴 (talk) 18:54, 26 October 2023 (UTC)[reply]
  • relevant interwiki link: d:WD:property proposal/plural forms Arlo Barnes (talk) 04:15, 9 February 2024 (UTC)[reply]

(would be better with types representing a stream of bytes)

• To do MD2 - MD2 (Z10135)
• To do MD4 - MD4 (Z10136)
• To do MD5 - MD5 (Z10137)
• To do RIPEMD-128 - RIPEMD-128 (Z10138)
• To do RIPEMD-160 - RIPEMD-160 (Z10139)
• To do BLAKE2b-160 - BLAKE2b-160 (Z10140)
• To do BLAKE2b-256 - BLAKE2b-256 (Z10141)
• To do BLAKE2b-384 - BLAKE2b-384 (Z10142)
• To do BLAKE2b-512 - BLAKE2b-512 (Z10143)
• To do BLAKE2s-128 - BLAKE2s-128 (Z10144)
• To do BLAKE2s-160 - BLAKE2s-160 (Z10145)
• To do BLAKE2s-224 - BLAKE2s-224 (Z10146)
• To do BLAKE2s-256 - BLAKE2s-256 (Z10147)
• To do SHA-224 - SHA-224 (Z10149)
• To do HMAC-SHA-256
• To do SHAKE-128 - SHAKE-128 (Z10150)
• To do SHAKE-256 - SHAKE-256 (Z10151)

• return colour contrast ratio (per [1]) of two RGB colours (provided as strings e.g. "#FF0000")

Note: 'time' type not yet supported, use 'string' (or for strictly numeric values, 'natural number')

Gregorian to Bangla (Z12926): Returns the Bangla equivalent date of a Gregorian date format. The input fields represent the Year, month, and day, respectively.

decimalises and secularises the Gregorian

• day names: is the day name part of the French Republican Calendar 'rural' naming? (Z13006): tests if input is one of the French-language names for days in the FRC Not done yet

widely used calendar derived from the Julian, basis for ISO 8601

• check if year is leap year

  Done is leap year (Gregorian calendar) (Z10996) - (2020 ⇒ true; 2023 ⇒ false; 2100 ⇒ false)

• return weekday (2023-08-03 ⇒ Thursday (or should this return Q129, for Thursday (Q129)?))

  Done get weekday from date (Z13163)

• date to weekday number (0-6) -- Done get weekday number (starting Sunday=1) from date (Z16914)
• date to ISO week number ISO week date (Q2110154)
• advance n days (2023-08-03 & "69" ⇒ 2023-10-11)

  Doneadvance n days to get a later date (D/M/YYYY) (Z13306)

• go back n days -- Done go back n days to get a previous date (D/M/YYYY) (Z16908)
• string to date
• date to ISO 8601 string
• date to year (yyyy)
• date to month of the year (1-12)
• date to month name (January-December)
• date to day of the month (1-31)
• date to hour of the day (0-23)
• date to minutes (0-59)
• date to seconds (0-59)

• w:en:Holocene calendar#Conversion

a solar calendar, also called Hijri

mostly used by astronomers, some historians, and some Orthodox Christian denominations

• check if year is leap year

  Done is leap year (Julian calendar) (Z11015) - (2020 ⇒ true; 2023 ⇒ false; 2100 ⇒ true)

including civil and clerical forms

also called Jalali

• check if year is leap year

  Done is leap year (Jalali calendar) (Z11011) - (1399 ⇒ true; 1400 ⇒ false)

• round up ("1.289" & "2" ⇒ "1.29"; "5678" & "2" ⇒ "5700")

  So if the number is floating point, round to n decimal places, and if not, round to n significant figures. Is that right? BrightSunMan (talk) 19:36, 24 December 2023 (UTC)[reply]

• round down
• return integer value (5678.678 ⇒ 5678)
• decode Roman numerals ("X" ⇒ 10; 2023 ⇒ MMXXIII)

  Done : Roman to Arabic numeral (Z11023): Convert a Roman numeral to Arabic numeral

• encode as Roman numerals (10 ⇒ "X"; MMXXIII ⇒ 2023)

  Done : Arabic to Roman numeral (Z11022): Convert a natural number [1, 4999] to roman numeral

• English cardinal (Z13587): expresses a natural number in English words (23 ⇒ "twenty-three")
• English ordinal (23 ⇒ "twenty-third")

  Done English ordinal (Z14526) (Composition only, with English cardinal (Z13587) and English cardinal to ordinal (Z14523))

• Natural number with English ordinal suffix (Z14531)

  Done (Python only)

• English cardinal to ordinal (Z14523): Converts standard English cardinal forms like “twenty-three” to the corresponding ordinal form, like “twenty-third”.

  Done (Python only)

• Done: Body Mass Index (80kg and 1.80m ⇒ 24)
  • Done: (!) Body Mass Index (metric) (Z12526): Calculate a BMI given a mass in kilograms and height in meters
  • Done: (!) Body Mass Index (imperial) (Z12572): Calculate a BMI given a mass in pounds and height in inches
• Convert money from US$ to anything else
  • requires source of conversion rates, which is a hole in function-likeness
• Done Kronecker delta (Z15849): returns 1 if the two natural number inputs are equal, and 0 if they are unequal
• Arabic numeral to Etruscan numeral
• Etruscan numeral to Arabic numeral

• parse a string as JSON
• extract string from JSON object based on JSONPath ({"name":"Alice"}, "$.name" ⇒ "Alice")

  Why not first convert a JSON string to an object, and then have a function that extracts fields based on JSONPath? Doing Stringly-typed things like this proposal as defined isn't a good idea. 0xDeadbeef (talk) 16:16, 5 August 2023 (UTC)[reply]

  This seems to be a good idea, thanks! I moved and splitted the proposal accordingly. --1-Byte (talk) 09:51, 6 August 2023 (UTC)[reply]

  is it okay to go ahead to create this 'extract string from JSON object based on JSONPath' as a function ? Dolphyb (talk) 16:14, 15 February 2024 (UTC)[reply]

• Sum the elements of a numeric list - sum the elements of a list of natural numbers (Z14038)
• Product of the elements of a numeric list
• Done length of a list (Z12681): number of objects on a list
• flat a list (Z12676): flatten a list to limited depth
• Slice of list elements: for the supplied list, return a list of elements that are at indexes between a supplied range n:m
  • Zero indexing is used (first element is index 0)?
  • n and m are are included in the range?
  • What happens if n and/or m are invalid indexes?
• Remove slice of elements from list: return the supplied list with elements between a supplied range of indexes removed
  • Zero indexing is used (first element is index 0)?
  • n and m are are included in the range?
  • What happens if n and/or m are invalid indexes?
• Done First n elements of list: return a list of the first n elements of a supplied list - get the first n elements of a list (Z13366)
• Done Last n elements of list: return a list of the last n elements of a supplied list - get the last n elements of a list (Z13362)
• Every nth element of list: returns every nth element of the supplied list
• Done - get the nth element of a list (Z13397): When given a valid index (1-based) return the nth element of the supplied list otherwise return nothing
• Remove every nth element of list: removes every nth element of the supplied list -
• Done remove the nth element from a list (Z13429): When given a valid index remove the element at the position and return the supplied list otherwise return nothing
• sample n objects from list (return up to n random objects from the list)
• Jaccard similarity coefficient (see https://en.wikipedia.org/wiki/Jaccard_index)

w:en:planetary coordinate system, w:en:well-known text representation of coordinate reference systems

• convert coordinates outside of the ranges (-180, 180) for longitude and (-90, 90) for latitude to a canonical form

• convert coordinates outside of the ranges [0, 360) for longitude and (-90, 90) for latitude to a canonical form

• Fahrenheit to Celsius (Z15560): Converts Fahrenheit (°F) to Celsius (°C)

• ZID of object type (Z17893): returns a string with the ZID of the type of the object passed in

• WF:importing