Context related to an evocation of pathfinding

Introduced properties

type L: Link

a_star :: PathContext :: L

Type of the links in graph

type N: Node

a_star :: PathContext :: N

Type of the nodes in graph

abstract fun cost(link: L): Int

a_star :: PathContext :: cost

Get cost of a link

init defaultinit(graph: Graph[N, L])

a_star :: PathContext :: defaultinit

fun graph: Graph[N, L]

a_star :: PathContext :: graph

Graph to which is associated self

protected fun graph=(graph: Graph[N, L])

a_star :: PathContext :: graph=

Graph to which is associated self

abstract fun heuristic_cost(a: N, b: N): Int

a_star :: PathContext :: heuristic_cost

Heuristic

abstract fun is_blocked(link: L): Bool

a_star :: PathContext :: is_blocked

Is that link blocked?

abstract fun worst_cost: Int

a_star :: PathContext :: worst_cost

Worst cost of all the link's costs

abstract fun worst_heuristic_cost: Int

a_star :: PathContext :: worst_heuristic_cost

The worst cost suggested by the heuristic

Redefined properties

redef type SELF: PathContext

a_star $ PathContext :: SELF

Type of this instance, automatically specialized in every class

redef fun core_serialize_to(v: Serializer)

a_star $ PathContext :: core_serialize_to

Actual serialization of self to serializer

redef init from_deserializer(v: Deserializer)

a_star $ PathContext :: from_deserializer

Create an instance of this class from the deserializer

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 L: Link

a_star :: PathContext :: L

Type of the links in graph

type N: Node

a_star :: PathContext :: N

Type of the nodes in graph

type SELF: Object

core :: Object :: SELF

Type of this instance, automatically specialized in every class

protected fun accept_json_serializer(v: JsonSerializer)

serialization :: Serializable :: accept_json_serializer

Refinable service to customize the serialization of this class to JSON

protected fun accept_msgpack_attribute_counter(v: AttributeCounter)

serialization :: Serializable :: accept_msgpack_attribute_counter

Hook to customize the behavior of the AttributeCounter

protected fun accept_msgpack_serializer(v: MsgPackSerializer)

serialization :: Serializable :: accept_msgpack_serializer

Hook to customize the serialization of this class to MessagePack

protected fun add_to_bundle(bundle: NativeBundle, key: JavaString)

serialization :: Serializable :: add_to_bundle

Called by []= to dynamically choose the appropriate method according

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 core_serialize_to(serializer: Serializer)

serialization :: Serializable :: core_serialize_to

Actual serialization of self to serializer

abstract fun cost(link: L): Int

a_star :: PathContext :: cost

Get cost of a link

init defaultinit

serialization :: Serializable :: defaultinit

init defaultinit(graph: Graph[N, L])

a_star :: PathContext :: defaultinit

init defaultinit

core :: Object :: defaultinit

init from_deserializer(deserializer: Deserializer)

serialization :: Serializable :: from_deserializer

Create an instance of this class from the deserializer

fun get_class: CLASS

core :: Object :: get_class

The meta-object representing the dynamic type of self.

fun graph: Graph[N, L]

a_star :: PathContext :: graph

Graph to which is associated self

protected fun graph=(graph: Graph[N, L])

a_star :: PathContext :: graph=

Graph to which is associated self

fun hash: Int

core :: Object :: hash

The hash code of the object.

abstract fun heuristic_cost(a: N, b: N): Int

a_star :: PathContext :: heuristic_cost

Heuristic

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_blocked(link: L): Bool

a_star :: PathContext :: is_blocked

Is that link blocked?

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.

protected fun msgpack_extra_array_items: Int

serialization :: Serializable :: msgpack_extra_array_items

Hook to request a larger than usual metadata array

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

fun serialize_msgpack(plain: nullable Bool): Bytes

serialization :: Serializable :: serialize_msgpack

Serialize self to MessagePack bytes

fun serialize_to(serializer: Serializer)

serialization :: Serializable :: serialize_to

Serialize self to serializer

fun serialize_to_json(plain: nullable Bool, pretty: nullable Bool): String

serialization :: Serializable :: serialize_to_json

Serialize self to JSON

intern fun sys: Sys

core :: Object :: sys

Return the global sys object, the only instance of the Sys class.

fun to_json: String

serialization :: Serializable :: to_json

Serialize self to plain JSON

abstract fun to_jvalue(env: JniEnv): JValue

core :: Object :: to_jvalue

fun to_pretty_json: String

serialization :: Serializable :: to_pretty_json

Serialize self to plain pretty JSON

fun to_s: String

core :: Object :: to_s

User readable representation of self.

abstract fun worst_cost: Int

a_star :: PathContext :: worst_cost

Worst cost of all the link's costs

abstract fun worst_heuristic_cost: Int

a_star :: PathContext :: worst_heuristic_cost

The worst cost suggested by the heuristic

Ancestors

interface Object

The root of the class hierarchy.

Parents

interface Serializable

serialization :: Serializable

Instances of this class can be passed to Serializer::serialize

Children

class ConstantPathContext

a_star :: ConstantPathContext

Simple context with constant cost on each links

class PositionPathContext

a_star :: PositionPathContext

Context for a graph with positions

class WeightedPathContext

a_star :: WeightedPathContext

A PathContext for graphs with WeightedLink

Class definitions

a_star $ PathContext

# Context related to an evocation of pathfinding
abstract class PathContext
	serialize

	# Type of the nodes in `graph`
	type N: Node

	# Type of the links in `graph`
	type L: Link

	# Graph to which is associated `self`
	var graph: Graph[N, L]

	# Worst cost of all the link's costs
	fun worst_cost: Int is abstract

	# Get cost of a link
	fun cost(link: L): Int is abstract

	# Is that link blocked?
	fun is_blocked(link: L): Bool is abstract

	# Heuristic
	fun heuristic_cost(a, b: N): Int is abstract

	# The worst cost suggested by the heuristic
	fun worst_heuristic_cost: Int is abstract
end

lib/a_star/a_star.nit:330,1--357,3