StartsWith and IsStartOf (String functions) - Revision history

Alex at 03:09, 21 February 2020

2020-02-21T03:09:26Z

← Older revision		Revision as of 03:09, 21 February 2020
Line 1:		Line 1:
	{{Template:String:StartsWith and IsStartOf subtitle}}		{{Template:String:StartsWith and IsStartOf subtitle}}
	<var>StartsWith</var> can be conveniently used to check whether a starts with ~~a known~~ string; <var>IsStartOf</var> can be conveniently used to check whether a string is an abbreviation of a known string.		<var>StartsWith</var> can be conveniently used to check whether one string starts with another string; <var>IsStartOf</var> can be conveniently used to check whether a string is an abbreviation of a known string.

	==Syntax==		==Syntax==

JAL at 21:11, 5 November 2012

2012-11-05T21:11:53Z

← Older revision		Revision as of 21:11, 5 November 2012
Line 21:		Line 21:

	<tr><th>longerString</th>		<tr><th>longerString</th>
	<td>A string which is examined to see if ~~the~~ <var class="term">~~abbreviation~~</var> is an abbreviation of it.</td></tr>		<td>A string which is examined to see if <var class="term">string</var> is an abbreviation of it.</td></tr>

	<tr><th><var>MinLength</var></th>		<tr><th><var>MinLength</var></th>
	<td>This name-required argument is a non-negative number, specifying the minimum length of <var class="term">~~abbreviation~~</var> to be considered an abbreviation of <var class="term">longerString</var>. Note that if this is 0, then the null string is an abbreviation of any value of the <var class="term">longerString</var> argument; if this is non-0, then the null string is never an abbreviation.		<td>This [[Notation conventions for methods#Named parameters\|name required]] argument is a non-negative number, specifying the minimum length of <var class="term">string</var> to be considered an abbreviation of <var class="term">longerString</var>. Note that if this is 0, then the null string is an abbreviation of any value of the <var class="term">longerString</var> argument; if this is non-0, then the null string is never an abbreviation.

	This argument is only used by <var>IsStartOf</var>; for <var>StartsWith</var>, <var>MinLength</var> is effectively 0.		This argument is only used by <var>IsStartOf</var>; for <var>StartsWith</var>, <var>MinLength</var> is effectively 0.

JAL: /* Syntax terms */

2012-11-05T21:08:46Z

Syntax terms

← Older revision		Revision as of 21:08, 5 November 2012
Line 18:		Line 18:
	<li><var class="term">abbreviation</var>, for <var>IsStartOf</var></ul></td></tr>		<li><var class="term">abbreviation</var>, for <var>IsStartOf</var></ul></td></tr>

	<tr><th>abbreviation</th><td>A string which is examined to see if it is an abbreviation (that is, an initial substring) of <var class="term">~~longerString~~</var>.</td></tr>		<tr><th>abbreviation</th><td>A string which is examined to see if it is an abbreviation (that is, an initial substring) of <var class="term">string</var>.</td></tr>

	<tr><th>longerString</th>		<tr><th>longerString</th>

JAL2 at 01:47, 24 February 2012

2012-02-24T01:47:47Z

← Older revision		Revision as of 01:47, 24 February 2012
Line 1:		Line 1:
	{{Template:String:StartsWith and IsStartOf subtitle}}		{{Template:String:StartsWith and IsStartOf subtitle}}
			<var>StartsWith</var> can be conveniently used to check whether a starts with a known string; <var>IsStartOf</var> can be conveniently used to check whether a string is an abbreviation of a known string.

	==Syntax==		==Syntax==
	{{Template:String:StartsWith syntax}}		{{Template:String:StartsWith syntax}}
	{{Template:String:IsStartOf syntax}}		{{Template:String:IsStartOf syntax}}
	<var>StartsWith</var> can be conveniently used to check whether a starts with a known string; <var>IsStartOf</var> can be conveniently used to check whether a string is an abbreviation of a known string.
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%boolean</th>		<tr><th>%boolean</th>
	<td>The <var>Boolean</var> result is <var>True</var> if <var class="term">abbreviation</var> is the same as the initial substring, whose length is the length of <var class="term">abbreviation</var>, of <var class="term">longerString</var>.		<td>The <var>[[Boolean enumeration\|Boolean]]</var> result is <var>True</var> if <var class="term">abbreviation</var> is the same as the initial substring, whose length is the length of <var class="term">abbreviation</var>, of <var class="term">longerString</var>.

	In addition, for <var>IsStartOf</var>, the length of the method object <var class="term">abbreviation</var> is at least the value of the <var>MinLength</var> argument.		In addition, for <var>IsStartOf</var>, the length of the method object <var class="term">abbreviation</var> is at least the value of the <var>MinLength</var> argument.
Line 16:		Line 17:
	<ul><li><var class="term">longerString</var>, whose intial characters are examined, for <var>StartsWith</var>		<ul><li><var class="term">longerString</var>, whose intial characters are examined, for <var>StartsWith</var>
	<li><var class="term">abbreviation</var>, for <var>IsStartOf</var></ul></td></tr>		<li><var class="term">abbreviation</var>, for <var>IsStartOf</var></ul></td></tr>
	<tr><th>abbreviation</th><td>A string which is examined to see if it is an abbreviation (~~i.e.~~, an initial substring) of <var class="term">longerString</var>.</td></tr>
			<tr><th>abbreviation</th><td>A string which is examined to see if it is an abbreviation (that is, an initial substring) of <var class="term">longerString</var>.</td></tr>

	<tr><th>longerString</th>		<tr><th>longerString</th>
	<td>A string which is examined to see if the <var class="term">abbreviation</var> is an abbreviation of it.</td></tr>		<td>A string which is examined to see if the <var class="term">abbreviation</var> is an abbreviation of it.</td></tr>

	<tr><th><var>MinLength</var></th>		<tr><th><var>MinLength</var></th>
	<td>This name-required argument is a non-negative number, specifying the minimum length of <var class="term">abbreviation</var> to be considered an abbreviation of <var class="term">longerString</var>. Note that if this is 0, then the null string is an abbreviation of any value of the <var class="term">longerString</var> argument; if this is non-0, then the null string is never an abbreviation.		<td>This name-required argument is a non-negative number, specifying the minimum length of <var class="term">abbreviation</var> to be considered an abbreviation of <var class="term">longerString</var>. Note that if this is 0, then the null string is an abbreviation of any value of the <var class="term">longerString</var> argument; if this is non-0, then the null string is never an abbreviation.

	This argument is only used by <var>IsStartOf</var>; for <var>StartsWith</var>, <var>MinLength</var> is effectively 0.		This argument is only used by <var>IsStartOf</var>; for <var>StartsWith</var>, <var>MinLength</var> is effectively 0.
Line 27:		Line 31:

	==Examples==		==Examples==
	===Checking whether string starts with some literal===		====Checking whether string starts with some literal====
	Hopefully the following fragment is self-evident:		Hopefully the following fragment is self-evident:
	<p class="code">if %name:toUpper:startsWith('DAV') then		<p class="code">if %name:toUpper:startsWith('DAV') then
Line 33:		Line 37:
	</p>		</p>

	===Determining if option is valid abbreviation===		====Determining if option is valid abbreviation====
	A common task is checking user input for a valid abbreviation for one of several longer terms. This is one motivation for the <var>MinLength</var> argument; there may be overlap in the initial substrings of the longer terms. Consider the following fragment:		A common task is checking user input for a valid abbreviation for one of several longer terms. This is one motivation for the <var>MinLength</var> argument; there may be overlap in the initial substrings of the longer terms. Consider the following fragment:
	<p class="code">%opt = %(system):[[Arguments (System function)\|arguments]]:toUpper		<p class="code">%opt = %(system):[[Arguments (System function)\|arguments]]:toUpper
Line 44:		Line 48:
	If the argument to this proc is <code>max</code>, that would not distinguish it between <code>maxAmount</code> and <code>maxTime</code>; hence the <var>MinLength</var> argument value of 5 is used to enforce that at least <code>maxAm</code> or <code>maxTi</code> is entered (a value of 4 would also have disambiguated the abbreviations in this case).		If the argument to this proc is <code>max</code>, that would not distinguish it between <code>maxAmount</code> and <code>maxTime</code>; hence the <var>MinLength</var> argument value of 5 is used to enforce that at least <code>maxAm</code> or <code>maxTi</code> is entered (a value of 4 would also have disambiguated the abbreviations in this case).

	===Several single-line examples===		====Several single-line examples====
	The following fragment:		The following fragment:
	<p class="code">PrintText {~= 'a':IsStartOf('abc', MinLength=1) }		<p class="code">PrintText {~= 'a':IsStartOf('abc', MinLength=1) }

Dme at 18:42, 8 February 2012

2012-02-08T18:42:09Z

← Older revision		Revision as of 18:42, 8 February 2012
Line 51:		Line 51:
	PrintText {~= 'x':IsStartOf('abc', MinLength=1) }		PrintText {~= 'x':IsStartOf('abc', MinLength=1) }
	PrintText {~= 'x':IsStartOf('abc', MinLength=0) }		PrintText {~= 'x':IsStartOf('abc', MinLength=0) }
	PrintText {~= '':IsStartOf('abc', MinLength=0) }		PrintText {~= '':IsStartOf('abc', MinLength=0) }
	</p>		</p>
	produces the following output:		produces the following output:

Dme: /* Syntax */

2011-06-29T17:32:19Z

Syntax

← Older revision		Revision as of 17:32, 29 June 2011
Line 4:		Line 4:
	{{Template:String:StartsWith syntax}}		{{Template:String:StartsWith syntax}}
	{{Template:String:IsStartOf syntax}}		{{Template:String:IsStartOf syntax}}
			<var>StartsWith</var> can be conveniently used to check whether a starts with a known string; <var>IsStartOf</var> can be conveniently used to check whether a string is an abbreviation of a known string.
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">

Dme: /* Examples */

2011-06-29T17:25:35Z

Examples

← Older revision		Revision as of 17:25, 29 June 2011
Line 26:		Line 26:

	==Examples==		==Examples==
			===Checking whether string starts with some literal===
			Hopefully the following fragment is self-evident:
			<p class="code">if %name:toUpper:startsWith('DAV') then
			print 'Name is probably Dave or David'
			</p>

	===Determining if option is valid abbreviation===		===Determining if option is valid abbreviation===
	A common task is checking user input for a valid abbreviation for one of several longer terms. This is one motivation for the <var>MinLength</var> argument; there may be overlap in the initial substrings of the longer terms. Consider the following fragment:		A common task is checking user input for a valid abbreviation for one of several longer terms. This is one motivation for the <var>MinLength</var> argument; there may be overlap in the initial substrings of the longer terms. Consider the following fragment:

Dme: /* Syntax terms */

2011-06-29T17:16:09Z

Syntax terms

← Older revision		Revision as of 17:16, 29 June 2011
Line 7:		Line 7:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%boolean</th>		<tr><th>%boolean</th>
	<td>The <var>Boolean</var> result ~~of <var>IsStartOf</var>~~ is <var>True</var> if~~:<ul><li>The length of the method object~~ <var class="term">~~string</var> is at least the value of the <var>MinLength</var> argument<br><b>and</b>:<li>the method object <var class="term">string~~</var> is the same as the initial substring, whose length is the length of <var class="term">~~string~~</var>, of ~~the~~ <var class="term">longerString</var> ~~argument~~.</ul>~~If either~~ of the ~~above conditions does not hold,~~ the ~~result is~~ <var>~~False~~</var>.</td></tr>		<td>The <var>Boolean</var> result is <var>True</var> if <var class="term">abbreviation</var> is the same as the initial substring, whose length is the length of <var class="term">abbreviation</var>, of <var class="term">longerString</var>.

			In addition, for <var>IsStartOf</var>, the length of the method object <var class="term">abbreviation</var> is at least the value of the <var>MinLength</var> argument.
			</td></tr>
	<tr><th>string</th>		<tr><th>string</th>
	<td>A string which is examined to see if it is an abbreviation (i.e., an initial substring) of <var class="term">longerString</var>.</td></tr>		<td>The method object string. Depending upon whether the <var>StartsWith</var> or <var>IsStartOf</var> method is being used, <var class="term">string</var> may be either the:
			<ul><li><var class="term">longerString</var>, whose intial characters are examined, for <var>StartsWith</var>
			<li><var class="term">abbreviation</var>, for <var>IsStartOf</var></ul></td></tr>
			<tr><th>abbreviation</th><td>A string which is examined to see if it is an abbreviation (i.e., an initial substring) of <var class="term">longerString</var>.</td></tr>
	<tr><th>longerString</th>		<tr><th>longerString</th>
	<td>A string which is examined to see if the ~~method object~~ <var class="term">~~string~~</var> is an abbreviation of it.</td></tr>		<td>A string which is examined to see if the <var class="term">abbreviation</var> is an abbreviation of it.</td></tr>
	<tr><th><var>MinLength</var></th>		<tr><th><var>MinLength</var></th>
	<td>This name-required argument is a non-negative number, specifying the minimum length of ~~the method object~~ <var class="term">~~string~~</var> to be considered an abbreviation of <var class="term">longerString</var>. Note that if this is 0, then the null string is an abbreviation of any value of the <var class="term">longerString</var> argument; if this is non-0, then the null string is never an abbreviation.</td></tr>		<td>This name-required argument is a non-negative number, specifying the minimum length of <var class="term">abbreviation</var> to be considered an abbreviation of <var class="term">longerString</var>. Note that if this is 0, then the null string is an abbreviation of any value of the <var class="term">longerString</var> argument; if this is non-0, then the null string is never an abbreviation.

			This argument is only used by <var>IsStartOf</var>; for <var>StartsWith</var>, <var>MinLength</var> is effectively 0.
			</td></tr>
	</table>		</table>

Dme at 16:57, 29 June 2011

2011-06-29T16:57:58Z

← Older revision		Revision as of 16:57, 29 June 2011
Line 1:		Line 1:
	{{Template:String:IsStartOf subtitle}}		{{Template:String:StartsWith and IsStartOf subtitle}}

	==Syntax==		==Syntax==
			{{Template:String:StartsWith syntax}}
	{{Template:String:IsStartOf syntax}}		{{Template:String:IsStartOf syntax}}
	===Syntax terms===		===Syntax terms===
Line 45:		Line 46:

	==See also==		==See also==
	{{Template:String:IsStartOf footer}}		{{Template:String:StartsWith and IsStartOf footer}}

Dme: moved IsStartOf (String function) to StartsWith and IsStartOf (String functions)

2011-06-29T16:55:31Z

moved IsStartOf (String function) to StartsWith and IsStartOf (String functions)

← Older revision	Revision as of 16:55, 29 June 2011
(No difference)