Packages

  • package root
    Definition Classes
    root
  • package de
    Definition Classes
    root
  • package sciss

    The interfaces are grouped into the following packages:

    Welcome to the Mellite API documentation.

    The interfaces are grouped into the following packages:

    The Lucre transactional object model:

    • de.sciss.lucre.stm is the base package for transactions, with things like Obj, Txn, Sys, and Cursor
    • de.sciss.lucre.artifact is the base package for file system artifacts, with classes Artifact and ArtifactLocation
    • de.sciss.lucre.expr is the base package for expression types such as IntObj, DoubleObj, etc.

    Other useful packages:

    • de.sciss.synth.io for reading and writing audio files
    • de.sciss.osc for general Open Sound Control interfaces
    Definition Classes
    de
  • package lucre
    Definition Classes
    sciss
  • package data
    Definition Classes
    lucre
  • object Ancestor
    Definition Classes
    data
  • Map
  • Tree
  • Vertex

sealed trait Map[T <: Exec[T], Version, A] extends Writable with Disposable[T]

Linear Supertypes
Disposable[T], Writable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Map
  2. Disposable
  3. Writable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. type K = Vertex[T, Version]

Abstract Value Members

  1. abstract def +=(entry: (K, A))(implicit tx: T): Map.this.type
  2. abstract def -=(vertex: K)(implicit tx: T): Map.this.type
  3. abstract def add(entry: (K, A))(implicit tx: T): Boolean

    Marks a given key with a given value.

    Marks a given key with a given value.

    entry

    the key-value pair (where the key is a vertex in the full tree)

    returns

    true if the mark is new, false if there had been a mark for the given vertex.

  4. abstract def debugPrint(implicit tx: T): String
  5. abstract def dispose()(implicit tx: T): Unit
    Definition Classes
    Disposable
  6. abstract def full: Tree[T, Version]
  7. abstract def get(vertex: K)(implicit tx: T): Option[A]

    Queries for a mark at a given version vertex.

    Queries for a mark at a given version vertex. Unlike nearest, this does not search in the map, but merely tests if the given vertex has been marked or not.

    vertex

    the version vertex to look up

    returns

    the value associated with that vertex, or None if the vertex is unmarked.

  8. abstract def nearest(vertex: K)(implicit tx: T): (K, A)

    Finds the nearest marked ancestor of a given version key.

    Finds the nearest marked ancestor of a given version key. Since the map is constructed with a defined root value, this method is guaranteed to succeed—if there are no other marks in the map, it will return the root value (unless the version argument is illegal, i.e. has a version lower than the root vertex' version).

    vertex

    the key to look for. The algorithm searches for the nearest ancestor in the marked map with a version less than or equal to the given version

    returns

    a pair consisting of the tree vertex found and the value with which it has been marked. If the query version vertex was marked, it will be that vertex which is returned, and not an ancestor.

  9. abstract def nearestOption(vertex: K)(implicit tx: T): Option[(K, A)]
  10. abstract def nearestWithFilter(vertex: K)(p: (Int) => Boolean)(implicit tx: T): Option[(K, A)]

    Searches for the nearest marked ancestor, where version control is handed over to a custom predicate function.

    Searches for the nearest marked ancestor, where version control is handed over to a custom predicate function. I.e., while nearestOption will test for a version that is less than or equal to the query version, the behaviour may be customised here. The predicate function is called with the versionInt field of the vertices, e.g. using the tree's intView.

    Only those vertices are considered for which the predicate is true.

    Note: This currently only works correctly if the predicate tests for version anteriority!

    vertex

    the query vertex

    p

    the predicate function for the integer view of the vertex versions

  11. abstract def remove(vertex: K)(implicit tx: T): Boolean
  12. abstract def valueFormat: TFormat[T, A]
  13. abstract def write(out: DataOutput): Unit
    Definition Classes
    Writable

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from Disposable[T]

Inherited from Writable

Inherited from AnyRef

Inherited from Any

Ungrouped