Number protocol - Revision history

Kevin Reid: add modPow, missing space for max and min, fix XXXes, mention other-number-type issue

2009-07-31T04:51:24Z

add modPow, missing space for max and min, fix XXXes, mention other-number-type issue

New page

For some type T which is like a number, these are the conventional messages to implement.

This protocol is implemented by [[Integer]] and [[Float64]].

{{XXX|This list is not complete, not properly documented, and not discussed.}}

{{XXX|Consider whether this page could be turned into a template which generates tests of the number protocol for specific number types.}}

{{XXX|This documentation needs to acknowledge behavior with respect to numbers of other types; e.g. where this is an integer and an argument is a float. Just saying type T doesn't acknowlege that the result might be of another type.}}

==Protocol==

{{instance msgdoc|add|1|<var>other</var> :T|T}}

Sugar expansion of [[+]]. {{XXX}} write documentation

{{instance msgdoc|subtract|1|<var>other</var> :T|T}}

Sugar expansion of [[-]]. {{XXX}} write documentation

{{instance msgdoc|multiply|1|<var>other</var> :T|T}}

Sugar expansion of [[*]]. {{XXX}} write documentation

{{instance msgdoc|floorDivide|1|<var>other</var> :T|T}}

Sugar expansion of [[operator //|//]]. {{XXX}} write documentation

{{instance msgdoc|approxDivide|1|<var>other</var> :T|T}}

Sugar expansion of [[operator /|/]]. {{XXX}} write documentation

{{instance msgdoc|remainder|1|<var>other</var> :T|T}}

Sugar expansion of [[operator %|%]]. {{XXX}} write documentation

{{instance msgdoc|mod|1|<var>other</var> :T|T}}

Sugar expansion of [[operator %%|%%]]. {{XXX}} write documentation

{{instance msgdoc|pow|1|<var>other</var> :T|T}}

Sugar expansion of [[operator **|**]]. {{XXX}} write documentation

{{instance msgdoc|modPow|2|<var>exponent</var> :T, <var>modulus</var> :T|T}}

Sugar expansion of <code>this ** exponent %% modulus</code>.

{{specbycode|<var>this</var>.pow(<var>exponent</var>).mod(<var>modulus</var>)}}

It is expected that when this is an integer, <var>modulus</var> is a nonzero integer and <var>exponent</var> is a positive integer, this operation will be [http://en.wikipedia.org/wiki/Modular_exponentiation implemented efficiently].

{{XXX|In [[E-on-Java]], a negative modulus will throw an exception rather than computing the compositional answer. The above spec I just wrote contradicts this. Resolve. --[[User:Kevin Reid|Kevin Reid]] 23:51, 30 July 2009 (CDT)}} [[Category:Unresolved design issues]]

{{instance msgdoc|negate|0||T}}

Sugar expansion of [[-]]. Return the additive inverse of the receiver.

{{instance msgdoc|abs|0||T}}

Return the [http://en.wikipedia.org/wiki/Absolute_value absolute value] of the receiver.

{{instance msgdoc|max|1|<var>other</var> :T|T}}

Compare the recipient to <var>other</var>, and return whichever is greater.

{{instance msgdoc|min|1|<var>other</var> :T|T}}

Compare the recipient to <var>other</var>, and return whichever is lesser.

{{stub}}

Kevin Reid: note on template

2009-03-07T23:30:25Z

note on template

←Older revision		Revision as of 23:30, 7 March 2009
Line 4:		Line 4:

	{{XXX}} This list is not complete, not properly documented, and not discussed.		{{XXX}} This list is not complete, not properly documented, and not discussed.
		+
		+	{{XXX}} Consider whether this page could be turned into a template which generates tests of the number protocol for specific number types.

	==Protocol==		==Protocol==

Kevin Reid: /* Protocol */ typo

2009-03-04T00:15:27Z

Protocol: typo

←Older revision		Revision as of 00:15, 4 March 2009
Line 38:		Line 38:
	Compare the recipient to <var>other</var>, and return whichever is greater.		Compare the recipient to <var>other</var>, and return whichever is greater.

-	{{instance msgdoc\|~~max~~\|1\|<var>other</var> :T\|T}}	+	{{instance msgdoc\|min\|1\|<var>other</var> :T\|T}}
	Compare the recipient to <var>other</var>, and return whichever is lesser.		Compare the recipient to <var>other</var>, and return whichever is lesser.

	{{stub}}		{{stub}}

Kevin Reid at 00:14, 4 March 2009

2009-03-04T00:14:51Z

←Older revision		Revision as of 00:14, 4 March 2009
Line 3:		Line 3:
	This protocol is implemented by [[Integer]] and [[Float64]].		This protocol is implemented by [[Integer]] and [[Float64]].

-	{{XXX\|This list is not complete, not properly documented, and not discussed.}}	+	{{XXX}} This list is not complete, not properly documented, and not discussed.
-		+
-	~~{{XXX\|Consider whether this page could be turned into a template which generates tests of the number protocol for specific number types.}}~~	+
-		+
-	{{XXX\|This documentation needs to acknowledge behavior with respect to numbers of other types; e.g. where this is an integer and an argument is a float. Just saying type T doesn't acknowlege that the result might be of another type.}}	+

	==Protocol==		==Protocol==
Line 30:		Line 26:

	Sugar expansion of [[operator /\|/]]. {{XXX}} write documentation		Sugar expansion of [[operator /\|/]]. {{XXX}} write documentation
-
-	~~{{instance msgdoc\|remainder\|1\|<var>other</var> :T\|T}}~~
-
-	~~Sugar expansion of [[operator %\|%]]. {{XXX}} write documentation~~
-
-	~~{{instance msgdoc\|mod\|1\|<var>other</var> :T\|T}}~~
-
-	~~Sugar expansion of [[operator %%\|%%]]. {{XXX}} write documentation~~
-
-	~~{{instance msgdoc\|pow\|1\|<var>other</var> :T\|T}}~~
-
-	~~Sugar expansion of [[operator \|]]. {{XXX}} write documentation~~
-
-	~~{{instance msgdoc\|modPow\|2\|<var>exponent</var> :T, <var>modulus</var> :T\|T}}~~
-
-	~~Sugar expansion of <code>this ** exponent %% modulus</code>.~~
-
-	~~{{specbycode\|<var>this</var>.pow(<var>exponent</var>).mod(<var>modulus</var>)}}~~
-
-	It is expected that when this is an integer, <var>modulus</var> is a nonzero integer and <var>exponent</var> is a positive integer, this operation will be [http://en.wikipedia.org/wiki/Modular_exponentiation implemented efficiently].
-
-	{{XXX\|In [[E-on-Java]], a negative modulus will throw an exception rather than computing the compositional answer. The above spec I just wrote contradicts this. Resolve. --[[User:Kevin Reid\|Kevin Reid]] 23:51, 30 July 2009 (CDT)}} [[Category:Unresolved design issues]]

	{{instance msgdoc\|negate\|0\|\|T}}		{{instance msgdoc\|negate\|0\|\|T}}
Line 62:		Line 36:

	{{instance msgdoc\|max\|1\|<var>other</var> :T\|T}}		{{instance msgdoc\|max\|1\|<var>other</var> :T\|T}}
-
	Compare the recipient to <var>other</var>, and return whichever is greater.		Compare the recipient to <var>other</var>, and return whichever is greater.

-	{{instance msgdoc\|~~min~~\|1\|<var>other</var> :T\|T}}	+	{{instance msgdoc\|max\|1\|<var>other</var> :T\|T}}
-		+
	Compare the recipient to <var>other</var>, and return whichever is lesser.		Compare the recipient to <var>other</var>, and return whichever is lesser.

	{{stub}}		{{stub}}