Number protocol

From Erights

Revision as of 04:51, 31 July 2009 (view source) Kevin Reid (Talk) (add modPow, missing space for max and min, fix XXXes, mention other-number-type issue) ← Previous diff		Revision as of 00:14, 4 March 2009 (view source) Kevin Reid (Talk | contribs) Next diff →
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}}

---

Revision as of 00:14, 4 March 2009

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.

Contents 1 Protocol 1.1 add/1 1.2 subtract/1 1.3 multiply/1 1.4 floorDivide/1 1.5 approxDivide/1 1.6 negate/0 1.7 abs/0 1.8 max/1 1.9 max/1

Protocol

add/1

Signature: add(other :T) :T

Sugar expansion of +. XXX write documentation

subtract/1

Signature: subtract(other :T) :T

Sugar expansion of -. XXX write documentation

multiply/1

Signature: multiply(other :T) :T

Sugar expansion of *. XXX write documentation

floorDivide/1

Signature: floorDivide(other :T) :T

Sugar expansion of //. XXX write documentation

approxDivide/1

Signature: approxDivide(other :T) :T

Sugar expansion of /. XXX write documentation

negate/0

Signature: negate() :T

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

abs/0

Signature: abs() :T

Return the absolute value of the receiver.

max/1

Signature: max(other :T) :T

Compare the recipient to other, and return whichever is greater.

max/1

Signature: max(other :T) :T

Compare the recipient to other, and return whichever is lesser.

This page is a stub; it should be expanded with more information. If doing so, check the original E web site and the mailing list archives for content which could be moved into this page.