An iterator over a Cartesian-product collection.

Introduced properties

fun collection: Cartesian[E, F]

cartesian :: CartesianIterator :: collection

The associated Cartesian-product collection.
protected fun collection=(collection: Cartesian[E, F])

cartesian :: CartesianIterator :: collection=

The associated Cartesian-product collection.
fun item_e: E

cartesian :: CartesianIterator :: item_e

First member of item.
fun item_f: E

cartesian :: CartesianIterator :: item_f

Second member of item.

Redefined properties

redef type SELF: CartesianIterator[E, F]

cartesian $ CartesianIterator :: SELF

Type of this instance, automatically specialized in every class
redef init init

cartesian $ CartesianIterator :: init

redef fun is_ok: Bool

cartesian $ CartesianIterator :: is_ok

Is there a current item ?
redef fun item: Pair[E, F]

cartesian $ CartesianIterator :: item

The current item.
redef fun next

cartesian $ CartesianIterator :: next

Jump to the next item.

All properties

fun !=(other: nullable Object): Bool

core :: Object :: !=

Have self and other different values?
fun +(other: Iterator[E]): Iterator[E]

core :: Iterator :: +

Combine two iterators.
fun ==(other: nullable Object): Bool

core :: Object :: ==

Have self and other the same value?
type CLASS: Class[SELF]

core :: Object :: CLASS

The type of the class of self.
type SELF: Object

core :: Object :: SELF

Type of this instance, automatically specialized in every class
fun all(pred: Fun1[E, Bool]): Bool

core :: Iterator :: all

Checks if all elements respect a predicate
fun alternate(e: E): Iterator[E]

core :: Iterator :: alternate

Alternate each item with e.
fun any(pred: Fun1[E, Bool]): Bool

core :: Iterator :: any

Checks if at least one element respects a predicate
protected fun class_factory(name: String): CLASS

core :: Object :: class_factory

Implementation used by get_class to create the specific class.
fun class_name: String

core :: Object :: class_name

The class name of the object.
fun collection: Cartesian[E, F]

cartesian :: CartesianIterator :: collection

The associated Cartesian-product collection.
protected fun collection=(collection: Cartesian[E, F])

cartesian :: CartesianIterator :: collection=

The associated Cartesian-product collection.
fun enumerate: EnumerateIter[E]

core :: Iterator :: enumerate

Iterator that gives the current count and element as a pair
fun filter(pred: Fun1[E, Bool]): FilterIter[E]

core :: Iterator :: filter

Iterator that filters elements by a predicate
fun finish

core :: Iterator :: finish

Post-iteration hook.
fun flat_map(f: Fun1[E, Iterator[Object]]): FlatMapIter[E, Object]

core :: Iterator :: flat_map

Maps every element to a nested structure then flattens it
fun fold(acc: Object, f: Fun2[Object, E, Object]): Object

core :: Iterator :: fold

Folds an iterator from the left
fun fold1(f: Fun2[E, E, E]): E

core :: Iterator :: fold1

Folds and apply two element at a time
fun for_each(f: Proc1[E])

core :: Iterator :: for_each

Apply a mutation function over all elements
fun get_class: CLASS

core :: Object :: get_class

The meta-object representing the dynamic type of self.
fun hash: Int

core :: Object :: hash

The hash code of the object.
fun head(length: Int): Iterator[E]

core :: Iterator :: head

Filter: keep only the first length items.
init init

core :: Object :: init

fun inspect: String

core :: Object :: inspect

Developer readable representation of self.
protected fun inspect_head: String

core :: Object :: inspect_head

Return "CLASSNAME:#OBJECTID".
abstract fun is_ok: Bool

core :: Iterator :: is_ok

Is there a current item ?
intern fun is_same_instance(other: nullable Object): Bool

core :: Object :: is_same_instance

Return true if self and other are the same instance (i.e. same identity).
fun is_same_serialized(other: nullable Object): Bool

core :: Object :: is_same_serialized

Is self the same as other in a serialization context?
intern fun is_same_type(other: Object): Bool

core :: Object :: is_same_type

Return true if self and other have the same dynamic type.
abstract fun item: E

core :: Iterator :: item

The current item.
fun item_e: E

cartesian :: CartesianIterator :: item_e

First member of item.
fun item_f: E

cartesian :: CartesianIterator :: item_f

Second member of item.
fun iterator: Iterator[E]

core :: Iterator :: iterator

Iterate over self
fun map(f: Fun1[E, Object]): MapIter[E, Object]

core :: Iterator :: map

Applies a function to every elements
abstract fun next

core :: Iterator :: next

Jump to the next item.
fun next_by(step: Int)

core :: Iterator :: next_by

Jump to the next item step times.
intern fun object_id: Int

core :: Object :: object_id

An internal hash code for the object based on its identity.
fun order_by(f: Fun1[E, Comparable]): OrderedIter[E]

core :: Iterator :: order_by

Generates an Iterator whose elements are sorted by the function
fun output

core :: Object :: output

Display self on stdout (debug only).
intern fun output_class_name

core :: Object :: output_class_name

Display class name on stdout (debug only).
fun select(predicate: Function[E, Bool]): Iterator[E]

core :: Iterator :: select

Filter: reject items that does not meet some criteria.
fun seq_uniq: Iterator[E]

core :: Iterator :: seq_uniq

Filter: reject continuous sequences of duplicates
fun serialization_hash: Int

core :: Object :: serialization_hash

Hash value use for serialization
fun skip(item: E): Iterator[E]

core :: Iterator :: skip

Filter: reject a given item.
fun skip_head(length: Int): Iterator[E]

core :: Iterator :: skip_head

Filter: reject the first length items.
fun skip_tail(length: Int): Iterator[E]

core :: Iterator :: skip_tail

Filter: reject the last length items.
fun sort: Iterator[E]

core :: Iterator :: sort

Filter: sort with default_comparator.
fun sort_with(comparator: Comparator): Iterator[E]

core :: Iterator :: sort_with

Filter: sort with a given comparator.
fun start

core :: Iterator :: start

Pre-iteration hook.
intern fun sys: Sys

core :: Object :: sys

Return the global sys object, the only instance of the Sys class.
fun tail(length: Int): Iterator[E]

core :: Iterator :: tail

Filter: keep only the last length items.
fun to_a: Array[E]

core :: Iterator :: to_a

Interate on self and build an array
abstract fun to_jvalue(env: JniEnv): JValue

core :: Object :: to_jvalue

fun to_s: String

core :: Object :: to_s

User readable representation of self.
fun to_step(step: Int): Iterator[E]

core :: Iterator :: to_step

A decorator around self that advance self a given number of steps instead of one.
fun uniq: Iterator[E]

core :: Iterator :: uniq

Filter: reject duplicates.
package_diagram cartesian::CartesianIterator CartesianIterator core::Iterator Iterator cartesian::CartesianIterator->core::Iterator core::Object Object core::Iterator->core::Object ...core::Object ... ...core::Object->core::Object

Ancestors

interface Object

core :: Object

The root of the class hierarchy.

Parents

interface Iterator[E: nullable Object]

core :: Iterator

Iterators generate a series of elements, one at a time.

Class definitions

cartesian $ CartesianIterator
# An iterator over a `Cartesian`-product collection.
class CartesianIterator[E,F]
	super Iterator[Pair[E,F]]

	# The associated Cartesian-product collection.
	var collection: Cartesian[E,F]

	# The iterator over the first collection of the Cartesian product.
	# Will be used only once.
	private var ice: Iterator[E] is noinit

	# The iterator over the second collection of the Cartesian product.
	# Will be used once for each element of the first collection.
	private var icf: Iterator[F] is noinit

	init do
		# Initialize each iterator
		ice = collection.ce.iterator
		icf = collection.cf.iterator
	end

	redef fun is_ok do return ice.is_ok and icf.is_ok

	redef fun item do
		# We lazily create the pair here
		var res = item_cache
		if res == null then
			res = new Pair[E,F](ice.item, icf.item)
			item_cache = res
		end
		return res
	end

	# Cached pair created by `item` and cleared by `next`.
	private var item_cache: nullable Pair[E,F] = null

	redef fun next do
		# Next item in the second iterator
		icf.next
		if not icf.is_ok then
			# If it is over, then reset it and advance the first iterator
			icf = collection.cf.iterator
			ice.next
		end
		# Reset the cache
		item_cache = null
	end

	# First member of `item`.
	#
	# This method shortcut the allocation of a `Pair`, thus should be more time and memory efficient.
	fun item_e: E do return ice.item

	# Second member of `item`.
	#
	# This method shortcut the allocation of a `Pair`, thus should be more time and memory efficient.
	fun item_f: E do return icf.item
end
lib/cartesian/cartesian.nit:125,1--182,3