Result from path finding and a walkable path

Introduced properties

fun at_end_of_path: Bool

a_star :: AStarPath :: at_end_of_path

Are we at the end of this path?
init defaultinit(total_cost: Int)

a_star :: AStarPath :: defaultinit

fun nodes: List[N]

a_star :: AStarPath :: nodes

Nodes composing this path
protected fun nodes=(nodes: List[N])

a_star :: AStarPath :: nodes=

Nodes composing this path
fun peek_step: N

a_star :: AStarPath :: peek_step

Peek at the next step of the path
fun step: N

a_star :: AStarPath :: step

Step on the path and get the next node to travel
fun total_cost: Int

a_star :: AStarPath :: total_cost

Total cost of this path
protected fun total_cost=(total_cost: Int)

a_star :: AStarPath :: total_cost=

Total cost of this path

Redefined properties

redef type SELF: AStarPath[N]

a_star $ AStarPath :: SELF

Type of this instance, automatically specialized in every class
redef fun core_serialize_to(v: Serializer)

a_star $ AStarPath :: core_serialize_to

Actual serialization of self to serializer
redef init from_deserializer(v: Deserializer)

a_star $ AStarPath :: 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 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
fun at_end_of_path: Bool

a_star :: AStarPath :: at_end_of_path

Are we at the end of this path?
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
init defaultinit(total_cost: Int)

a_star :: AStarPath :: 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 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.
protected fun msgpack_extra_array_items: Int

serialization :: Serializable :: msgpack_extra_array_items

Hook to request a larger than usual metadata array
fun nodes: List[N]

a_star :: AStarPath :: nodes

Nodes composing this path
protected fun nodes=(nodes: List[N])

a_star :: AStarPath :: nodes=

Nodes composing this path
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 peek_step: N

a_star :: AStarPath :: peek_step

Peek at the next step of the path
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
fun step: N

a_star :: AStarPath :: step

Step on the path and get the next node to travel
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.
fun total_cost: Int

a_star :: AStarPath :: total_cost

Total cost of this path
protected fun total_cost=(total_cost: Int)

a_star :: AStarPath :: total_cost=

Total cost of this path
package_diagram a_star::AStarPath AStarPath serialization::Serializable Serializable a_star::AStarPath->serialization::Serializable core::Object Object serialization::Serializable->core::Object ...core::Object ... ...core::Object->core::Object

Ancestors

interface Object

core :: Object

The root of the class hierarchy.

Parents

interface Serializable

serialization :: Serializable

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

Class definitions

a_star $ AStarPath
# Result from path finding and a walkable path
class AStarPath[N]
	serialize

	# Total cost of this path
	var total_cost: Int

	# Nodes composing this path
	var nodes = new List[N]

	private var at: Int = 0

	# Step on the path and get the next node to travel
	fun step: N
	do
		assert nodes.length >= at else print "a_star::AStarPath::step failed, is at_end_of_path"

		var s = nodes[at]
		at += 1

		return s
	end

	# Peek at the next step of the path
	fun peek_step: N do return nodes[at]

	# Are we at the end of this path?
	fun at_end_of_path: Bool do return at >= nodes.length
end
lib/a_star/a_star.nit:300,1--328,3