c

Pro.Info

class _Class extends Idx.M.A.Basic[(String, Any)]

Object Generic Documentation

To document itself an object should implements Any.Able.ToInfo

// Actual scalqa.App.Memory object code
object Memory extends Any.Able.ToInfo {
  . . . . . .
  def toInfo = new Pro.Info(this, "App.Memory") += ("max", max.toBrief) +=
             ("total", total.toBrief) += ("free", free.toBrief) += ("used", used.toBrief)
}

App.Memory.lp                // Prints App.Memory{max=15.2gB,total=1.0gB,free=986.2mB,used=42.9mB}

App.Memory.toInfo.toBrief.lp // Prints App.Memory{15.2gB,1.0gB,980.8mB,48.3mB}

App.Memory.toInfo.toText.lp  // Prints App.Memory{max=15.2gB,
                             //                   total=1.0gB,
                             //                   free=980.8mB,
                             //                   used=48.3mB}
Ordering
  1. Alphabetic
Inherited
  1. Info
  2. Idx.M.A.Basic
  3. Custom.Proxy.Idx.M.Like
  4. Idx.M
  5. Any.Collection.M
  6. Any.Able.Remove
  7. Any.Able.Add
  8. Custom.Proxy.Idx.Like
  9. Any.Wrap
  10. Idx
  11. Any.Collection
  12. scala.AnyRef
  13. scala.Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Constructor

  1. new Info(target: Any, customIdOpt: Opt[String] = \/)
    Definition Classes
    _Class

Constant

  1. val real: Idx.Array.Buffer.Refs[(String, Any)]
    Attributes
    protected
    Definition Classes
    Basic_Trait
  2. val target: Any
    Attributes
    protected
    Definition Classes
    _Class

Method

  1. def add(v: (String, Any)): Unit

    Add

    Add

    Adds given v to target container

    // Generic example
    val x = Idx.M.make(1, 2, 3)
    
     x add 4
     x add 5
     x add 6
    
     x.all.lp // Prints: ~(1, 2, 3, 4, 5, 6)
    Definition Classes
    _TraitAdd
  2. def addAll(a: ~[(String, Any)]): Unit

    Add Stream

    Add Stream

    Adds given stream elements to target container

    // Generic example
    val x = Idx.M.make(1, 2, 3)
    
     x addAll 4 <> 6
     x addAll 7 ~+ 8 + 9
    
     x.all.lp // ~(1, 2, 3, 4, 5, 6, 7, 8, 9)
    Definition Classes
    _TraitAdd
  3. def addAllAt(i: Int, a: ~[(String, Any)]): Unit

    Add stream at position

    Add stream at position

    Adds stream elements at given position

    // Generic example
    val x = ('A' <> 'F').all.to[Idx.M]
    
    x.addAllAt(4, 'e' <> 'g')
    x.addAllAt(1, 'b' ~+ 'c' + 'd')
    
    x.all.lp // Prints: ~(A, b, c, d, B, C, D, e, f, g, E, F)
    Definition Classes
    _Trait
  4. def addAt(n: Int, e: (String, Any)): Unit

    Add at position

    Add at position

    Adds element at given position

    // Generic example
    val x = ('A' <> 'F').all.to[Idx.M]
    
    x.addAt(3, 'd')
    x.addAt(2, 'c')
    x.addAt(1, 'b')
    x.addAt(0, 'a')
    
    x.all.lp // Prints: ~(a, A, b, B, c, C, d, D, E, F)
    Definition Classes
    Like_Trait
  5. def all: ~[(String, Any)]

    Returns a Stream of all elements

    Returns a Stream of all elements

    The element order is same as in the Idx.

    val index = Idx.*(1,3,5,7)
    index.all.lp
    // Output
    ~(1, 3, 5, 7)
    Definition Classes
    Like_Trait_Trait
  6. def allLabels(separator: String = "="): ~[String]
    Definition Classes
    _Class
  7. def allNames: ~[String]
    Definition Classes
    _Class
  8. def allValues: ~[Any]
    Definition Classes
    _Class
  9. def apply(i: Int): (String, Any)

    Returns element at position

    Returns element at position

    Definition Classes
    Like_Trait
  10. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. def clear: Unit

    Remove everything

    Remove everything

    Clears container of all elements

    Definition Classes
    _TraitRemove
  12. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  15. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. def labels: String
    Definition Classes
    _Class
  19. def names: String
    Definition Classes
    _Class
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  23. def order(o: Ordering[(String, Any)]): Unit

    Sort

    Sort

    Reorganizes elements according to the given Ordering

    val iw: Idx.M[Int] = (0 ~+ 7 + 1 + 6 + 2 + 5 + 3 + 4).to[Idx.M]
    
    iw.order(Ordering.A.Int) // 'iw.sort' is same library shortcut
    
    iw.all.lp // Prints: ~(0, 1, 2, 3, 4, 5, 6, 7)*
    Definition Classes
    Like_Trait
  24. def remove(e: (String, Any)): Unit

    Remove

    Remove

    Removes all elements equal to provided

    // Generic example
    val x = Idx.M.make(1, 2, 3, 4, 5)
    
    x.remove(2)
    x.remove(3)
    x.remove(4)
    
    x.all.lp // Prints: ~(1, 5)
    Definition Classes
    _TraitRemove
  25. def removeAll(s: ~[(String, Any)]): Unit

    Remove all

    Remove all

    Removes all elements equal to any in provided stream

    // Generic example
    val x = Idx.M.make(1, 2, 3, 4, 5)
    
    x.removeAll(2 <> 4)
    x.removeAll(2 ~+ 3 + 4)
    
    x.all.lp // Prints: ~(1, 5)
    Definition Classes
    Remove
  26. def removeAt(i: Idx.Range): Unit

    Remove range

    Remove range

    Removes elements at given range

    // Generic example
    val x = (0 <> 10).all.to[Idx.M]
    
    x.removeAt(7 <> 8)
    x.removeAt(2 <> 4)
    
    x.all.lp // Prints: ~(0, 1, 5, 6, 9, 10)
    Definition Classes
    Like_Trait
  27. def removeAt(position: Int): Unit

    Remove at position

    Remove at position

    Removes element at given position

    // Generic example
    val x = ('A' <> 'D').all.to[Idx.M]
    
    x.removeAt(2)
    x.removeAt(1)
    
    x.all.lp // Prints: ~(A, D)
    Definition Classes
    _Trait
  28. def reposition(r: Idx.Range.Reposition): Unit

    Reorganizes elements

    Reorganizes elements

    Reorganizes elements according to the given reposition

    val iw: Idx.M[Int] = (0 <> 9).all.to[Idx.M]
    
    val r = Idx.Reposition.getByAll((3, 7) ~+ (7, 3) + (4, 6) + (6, 4))
    
    iw.all.lp
    iw.reposition(r)
    iw.all.lp
    
    // Output
    ~(0, 1, 2, 3, 4, 5, 6, 7, 8, 9)
    ~(0, 1, 2, 7, 6, 5, 4, 3, 8, 9)
    Definition Classes
    _Trait
  29. def size: Int

    Number of elements

    Number of elements

    Readily available, not calculated element count

    Idx.*(1,3,5,7).size.lp  // Prints: 4
    Definition Classes
    Like_Trait
  30. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  31. def toBrief: String

    Brief description

    Brief description

    One line object description with tag values without names

    Definition Classes
    _Class
  32. def toString(): String

    Description

    Description

    One line object description

    Definition Classes
    _Class → AnyRef → Any
  33. def toText: String

    Text description

    Text description

    Multi line description

    Definition Classes
    _Class
  34. def update(n: Int, a: (String, Any)): Unit

    Replaces element at position

    Replaces element at position

    Replaces an element at given position

    val iw: Idx.M[Int] = (0 <> 7).all.to[Idx.M]
    
    iw.update(7, 777)
    iw.update(3, 333)
    
    iw.all.lp // Prints: ~(0, 1, 2, 333, 4, 5, 6, 777)
    Definition Classes
    Like_Trait
  35. def values: String
    Definition Classes
    _Class
  36. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Operator

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +=(v: String): Info.this.type
    Definition Classes
    _Class
  4. def +=(v: (String, Any)): Info.this.type

    Add operator

    Add operator

    Calls add and returns container

    // Generic example
    val x = Idx.M.make(1, 2, 3)
    
     x += 4 += 5 += 6
    
     x.all.lp // Prints: ~(1, 2, 3, 4, 5, 6)
    Definition Classes
    Add
  5. def +=@(position: Int, element: (String, Any)): Info.this.type

    Add at position operator

    Add at position operator

    Adds element at given position

    // Generic example
    val x = ('A' <> 'F').all.to[Idx.M]
    
    x +=@ (3, 'd') +=@ (2, 'c') +=@ (1, 'b') +=@ (0, 'a')
    
    x.all.lp // Prints: ~(a, A, b, B, c, C, d, D, E, F)
    Definition Classes
    _Trait
  6. def +~=(v: ~[String]): Info.this.type
    Definition Classes
    _Class
  7. def +~=(stream: ~[(String, Any)]): Info.this.type

    Add Stream operator

    Add Stream operator

    Calls addAll and returns container

    // Generic example
    val x = Idx.M.make(1, 2, 3)
    
    x +~= (4 <> 6) +~= (7 ~+ 8 + 9)
    
    x.all.lp // ~(1, 2, 3, 4, 5, 6, 7, 8, 9)
    Definition Classes
    Add
  8. def +~=@(position: Int, a: ~[(String, Any)]): Info.this.type

    Add all at position operator

    Add all at position operator

    Adds stream elements at given position

    // Generic example
    val x = ('A' <> 'F').all.to[Idx.M]
    
    x +~=@ (4, 'e' <> 'g') +~=@ (1, 'b' ~+ 'c' + 'd')
    
    x.all.lp // Prints: ~(A, b, c, d, B, C, D, e, f, g, E, F)
    Definition Classes
    _Trait
  9. def -=(element: (String, Any)): Info.this.type

    Remove operator

    Remove operator

    Removes all elements equal to provided

    // Generic example
    val x = Idx.M.make(1, 2, 3, 4, 5)
    
    x =- 2 =- 3 =- 4
    
    x.all.lp // Prints: ~(1, 5)
    Definition Classes
    Remove
  10. def -=@(range: Idx.Range): Info.this.type

    Remove range operator

    Remove range operator

    Removes elements at given range

    // Generic example
    val x = (0 <> 10).all.to[Idx.M]
    
    x -=@ (7 <> 8) -=@ (2 <> 4)
    
    x.all.lp // Prints: ~(0, 1, 5, 6, 9, 10)
    Definition Classes
    _Trait
  11. def -=@(position: Int): Info.this.type

    Remove at position operator

    Remove at position operator

    Removes element at given position

    // Generic example
    val x = ('A' <> 'D').all.to[Idx.M]
    
    x -=@ 2 -=@ 1
    
    x.all.lp // Prints: ~(A, D)
    Definition Classes
    _Trait
  12. def -~=(stream: ~[(String, Any)]): Info.this.type

    Remove all operator

    Remove all operator

    Removes all elements equal to any in provided stream

    // Generic example
    val x = Idx.M.make(1, 2, 3, 4, 5)
    
    x =-~ (2 <> 4) =-~ (2 ~+ 3 + 4)
    
    x.all.lp // Prints: ~(1, 5)
    Definition Classes
    Remove
  13. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any

Property

  1. def id: String
    Definition Classes
    _Class
Linear Supertypes
Idx.M.A.Basic[(String, Any)], Custom.Proxy.Idx.M.Like[(String, Any)], Idx.M[(String, Any)], Any.Collection.M[(String, Any)], Any.Able.Remove[(String, Any)], Any.Able.Add[(String, Any)], Custom.Proxy.Idx.Like[(String, Any)], Any.Wrap[Idx.M[(String, Any)]], Idx[(String, Any)], Any.Collection[(String, Any)], AnyRef, Any
Source: _Class.scala