A match to a `request` in an `Index`

Introduced properties

init defaultinit(document: DOC, similarity: Float)

vsm :: IndexMatch :: defaultinit

fun document: DOC

vsm :: IndexMatch :: document

Document matching the request_vector

protected fun document=(document: DOC)

vsm :: IndexMatch :: document=

Document matching the request_vector

fun similarity: Float

vsm :: IndexMatch :: similarity

Similarity between the request and the doc.

protected fun similarity=(similarity: Float)

vsm :: IndexMatch :: similarity=

Similarity between the request and the doc.

Redefined properties

redef type SELF: IndexMatch[DOC]

vsm $ IndexMatch :: SELF

Type of this instance, automatically specialized in every class

redef fun to_s: String

vsm $ IndexMatch :: to_s

User readable representation of self.

All properties

fun !=(other: nullable Object): Bool

core :: Object :: !=

Have self and other different values?

abstract fun <(other: OTHER): Bool

core :: Comparable :: <

Is self lesser than other?

fun <=(other: OTHER): Bool

core :: Comparable :: <=

not other < self

fun <=>(other: OTHER): Int

core :: Comparable :: <=>

-1 if <, +1 if > and 0 otherwise

fun ==(other: nullable Object): Bool

core :: Object :: ==

Have self and other the same value?

fun >(other: OTHER): Bool

core :: Comparable :: >

other < self

fun >=(other: OTHER): Bool

core :: Comparable :: >=

not self < other

type CLASS: Class[SELF]

core :: Object :: CLASS

The type of the class of self.

type OTHER: Comparable

core :: Comparable :: OTHER

What self can be compared to?

type SELF: Object

core :: Object :: SELF

Type of this instance, automatically specialized in every class

fun clamp(min: OTHER, max: OTHER): OTHER

core :: Comparable :: clamp

Constraint self within [min..max]

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.

init defaultinit(document: DOC, similarity: Float)

vsm :: IndexMatch :: defaultinit

init defaultinit

core :: Object :: defaultinit

init defaultinit

core :: Comparable :: defaultinit

fun document: DOC

vsm :: IndexMatch :: document

Document matching the request_vector

protected fun document=(document: DOC)

vsm :: IndexMatch :: document=

Document matching the request_vector

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".

fun is_between(c: OTHER, d: OTHER): Bool

core :: Comparable :: is_between

c <= self <= d

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 max(other: OTHER): OTHER

core :: Comparable :: max

The maximum between self and other (prefers self if equals).

fun min(c: OTHER): OTHER

core :: Comparable :: min

The minimum between self and c (prefer self if equals)

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 similarity: Float

vsm :: IndexMatch :: similarity

Similarity between the request and the doc.

protected fun similarity=(similarity: Float)

vsm :: IndexMatch :: similarity=

Similarity between the request and the doc.

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.

Ancestors

interface Object

The root of the class hierarchy.

Parents

interface Comparable

core :: Comparable

The ancestor of class where objects are in a total order.

Class definitions

vsm $ IndexMatch

# A match to a `request` in an `Index`
class IndexMatch[DOC: Document]
	super Comparable

	# Document matching the `request_vector`
	var document: DOC

	# Similarity between the `request` and the `doc`.
	#
	# Result is in the range 0.0 .. 1.1 where 0.0 means no similarity and 1.0
	# means perfect similarity.
	var similarity: Float

	redef fun to_s do return "{document} ({similarity})"
end

lib/vsm/vsm.nit:375,1--389,3