EList

From Erights

(Difference between revisions)
Jump to: navigation, search
(fixed up some arg/return types, wrote some doc/test)
(document with/2 (written using javadoc and eoj [black-box] as references))
Line 125: Line 125:
{{instance msgdoc|valueType|0||[[Guard]]}}
{{instance msgdoc|valueType|0||[[Guard]]}}
-
{{instance msgdoc|with|1|<var>new</var>|[[ConstList]]}}
+
{{instance msgdoc|with|1|<var>value</var>|[[ConstList]]}}
-
Return a ConstList with the current elements of this list, followed by the one additional element <var>new</var>.
+
Return a ConstList with the current elements of this list, followed by the one additional element <var>value</var>.
 +
 
 +
{{specbycode|{{this}}.with({{this}}.size(), <var>value</var> :[[any]])}}
  ? abcd.with("e")
  ? abcd.with("e")
Line 137: Line 139:
{{XXX|more tests?}}
{{XXX|more tests?}}
-
{{instance msgdoc|with|2|<var>_</var> :[[Integer]], <var>_</var> :null|[[ConstList]]}}
+
{{instance msgdoc|with|2|<var>index</var> :[[Integer]], <var>value</var> :[[any]]|[[ConstList]]}}
 +
 
 +
Return a ConstList with the current elements of this list except that the element at <var>index</var> is <var>value</var>. Or, by cases:
 +
 
 +
* If <var>index</var> is less than the [[#size/0]], then that element is replaced in the result list.
 +
* If <var>index</var> is equal to [[#size/0]], then <var>value</var> is an additional element and the size is one greater. (This is equivalent to <code>{{this}} + [<var>value</var>]</code>.)
 +
* Otherwise, the index is out of bounds. {{XXX|specify error}}
 +
 
 +
{{XXX|write tests}}
<noinclude>
<noinclude>

Revision as of 04:15, 18 March 2009

EList is the abstract supertype (XXX establish terminology: supertype or superclass?) of ConstList, FlexList, and ReadOnlyList. (XXX complete list?)

All indexing is zero-based. All ranges are specified as beginning index, inclusive, to ending index, exclusive (not inclusive end or location and size).

Contents

Protocol

? def abcd := __identityFunc(["a", "b", "c", "d"]); null

XXX Used a program to generate this list of msgdoc headers from E-on-Java. Clean up and write specs.

add/1

Signature: add(_) :ConstList

asKeys/0

Signature: asKeys() :ConstMap

asMap/0

Signature: asMap() :ConstMap

asSet/0

Signature: asSet() :ConstSet

contains/1

Signature: contains(_ :null) :Boolean

diverge/0

Signature: diverge() :FlexList

diverge/1

Signature: diverge(_ :Guard) :FlexList

fetch/2

Signature: fetch(index :Integer, _ :Thunk) :any

get/1

Signature: get(index :Integer) :valueType

Return the element at index.

? abcd[0]
# value: "a"

? abcd[2]
# value: "c"

? abcd[-1]
# problem: <XXX specify form of error>

? abcd[4]
# problem: <XXX specify form of error>  

getArray/0

Signature: getArray() :any

getArray/1

Signature: getArray(_ :nullOk[Class]) :any

getArray/3

Signature: getArray(_ :nullOk[Class], _ :Integer, _ :Integer) :any

includes/1

Signature: includes(_ :nullOk[EList]) :Boolean

indexOf1/1

Signature: indexOf1(_) :Integer

indexOf1/2

Signature: indexOf1(_, _ :Integer) :Integer

iterate/1

Signature: iterate(assocFunc :AssocFunc) :void

last/0

Signature: last() :any

lastIndexOf1/1

Signature: lastIndexOf1(_) :Integer

lastIndexOf1/2

Signature: lastIndexOf1(_, _ :Integer) :Integer

lastStartOf/1

Signature: lastStartOf(_ :EList) :Integer

lastStartOf/2

Signature: lastStartOf(_ :EList, _ :Integer) :Integer

multiply/1

Signature: multiply(_ :Integer) :ConstList

printOn/4

Signature: printOn(_ :String, _ :String, _ :String, out :TextWriter) :void

readOnly/0

Signature: readOnly() :EList

Return an EList which is a read-only view of this list. If this list is immutable the result may be the same as this list.

run/2

Signature: run(start :Integer, end :Integer) :{{{4}}} :ConstList

Return a ConstList containing the subsequence of elements in this list starting with element index start and ending with the element before index end.

? abcd.run(1, 3)
# value: ["b", "c"]

? abcd.run(0, abcd.size())
# value: ["a", "b", "c", "d"]

? ESpec.requireWrongArgsFail(abcd, "run", [0..!(abcd.size()), 0..!(abcd.size())])

{{XXX the above 'ESpec' is an idea about defining some utilities

run/1

Signature: run(start :Integer) :ConstList

Equivalent to thisEList.run(start, thisEList.size()).

? abcd.run(1)
# value: ["b", "c", "d"]

? abcd.run(0)
# value: ["a", "b", "c", "d"] 


size/0

Signature: size() :Integer

Return the current number of elements of this list.

? abcd.size()
# value: 4

snapshot/0

Signature: snapshot() :ConstList

Return a ConstList with the current elements of this list.

XXX test this vs. mutation

? abcd.snapshot()
# value: ["a", "b", "c", "d"]

sort/0

Signature: sort() :ConstList

sort/1

Signature: sort(_ :CompFunc) :ConstList

startOf/1

Signature: startOf(_ :EList) :int32

startOf/2

Signature: startOf(_ :EList, _ :Integer) :int32

valueType/0

Signature: valueType() :Guard

with/1

Signature: with(value) :ConstList

Return a ConstList with the current elements of this list, followed by the one additional element value.

Equivalent to thisEList.with(thisEList.size(), value :any).

? abcd.with("e")
# value: ["a", "b", "c", "d", "e"]

? __identityFunc([]).with(1)
# value: [1]

XXX more tests?

with/2

Signature: with(index :Integer, value :any) :ConstList

Return a ConstList with the current elements of this list except that the element at index is value. Or, by cases:

  • If index is less than the #size/0, then that element is replaced in the result list.
  • If index is equal to #size/0, then value is an additional element and the size is one greater. (This is equivalent to thisEList + [value].)
  • Otherwise, the index is out of bounds. XXX specify error

XXX write tests

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.
Personal tools
more tools