interface Function[FROM: nullable Object, TO: nullable Object]

pipeline :: Function

Interface that reify a function.

Concrete subclasses must implements the apply method.

This interface helps to manipulate function-like objects.

The main usage it as a transformation; that takes an argument and produce a result. See map for example.

Another usage is as a predicate, with Function[E, Bool]. See Iterator::select for example.

Function with more than one argument can be reified with some uncurification. Eg. Function[ARG1, Function[ARG2, RES]].

NOTE: Nit is not a functionnal language, this class is a very basic way to simulate the reification of a simple function.

Introduced properties

abstract fun apply(e: FROM): TO

pipeline :: Function :: apply

How an element is mapped to another one.
fun map(i: Iterator[FROM]): Iterator[TO]

pipeline :: Function :: map

Filter: produce an iterator which each element is transformed.

Redefined properties

redef type SELF: Function[FROM, TO]

pipeline $ Function :: SELF

Type of this instance, automatically specialized in every class

All properties

fun !=(other: nullable Object): Bool

core :: Object :: !=

Have self and other different values?
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
abstract fun apply(e: FROM): TO

pipeline :: Function :: apply

How an element is mapped to another one.
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 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.
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".
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.
fun map(i: Iterator[FROM]): Iterator[TO]

pipeline :: Function :: map

Filter: produce an iterator which each element is transformed.
intern fun object_id: Int

core :: Object :: object_id

An internal hash code for the object based on its identity.
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 serialization_hash: Int

core :: Object :: serialization_hash

Hash value use for serialization
intern fun sys: Sys

core :: Object :: sys

Return the global sys object, the only instance of the Sys class.
abstract fun to_jvalue(env: JniEnv): JValue

core :: Object :: to_jvalue

fun to_s: String

core :: Object :: to_s

User readable representation of self.
package_diagram pipeline::Function Function core::Object Object pipeline::Function->core::Object

Parents

interface Object

core :: Object

The root of the class hierarchy.

Class definitions

pipeline $ Function 
# Interface that reify a function.
# Concrete subclasses must implements the `apply` method.
#
# This interface helps to manipulate function-like objects.
#
# The main usage it as a transformation; that takes an argument and produce a result.
# See `map` for example.
#
# Another usage is as a predicate, with `Function[E, Bool]`.
# See `Iterator::select` for example.
#
# Function with more than one argument can be reified with some uncurification.
# Eg. `Function[ARG1, Function[ARG2, RES]]`.
#
# NOTE: Nit is not a functionnal language, this class is a very basic way to
# simulate the reification of a simple function.
interface Function[FROM, TO]
	# How an element is mapped to another one.
	fun apply(e: FROM): TO is abstract

	# Filter: produce an iterator which each element is transformed.
	#
	#     var i = [1,2,3].iterator
	#     assert fun_to_s.map(i).to_a  == ["1", "2", "3"]
	#
	# Note: because there is no generic method in Nit (yet?),
	# there is no way to have a better API.
	# eg. with the Iterator as receiver and the function as argument.
	# (see `Iterator::select`)
	fun map(i: Iterator[FROM]): Iterator[TO]
	do
		return new PipeMap[FROM, TO](i, self)
	end
end
lib/pipeline/pipeline.nit:292,1--325,3
Nit standard library. Version .