scala.collection.generic

# AtomicIndexFlag

#### trait AtomicIndexFlag extends Signalling

A mixin trait that implements index flag behaviour using atomic integers. The `setIndex` operation is wait-free, while conditional set operations `setIndexIfGreater` and `setIndexIfLesser` are lock-free and support only monotonic changes.

Source
  Signalling.scala

Linear Supertypes
Signalling, AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering

1. Alphabetic
2. By inheritance

Inherited

1. AtomicIndexFlag
2. Signalling
3. AnyRef
4. Any

Implicitly

1. by any2stringadd
2. by StringFormat
3. by Ensuring
4. by ArrowAssoc

1. Hide All
2. Show all

Learn more about member selection
Visibility

1. Public
2. All

### Abstract Value Members

1. #### abstract def abort(): Unit

   Sends an abort signal to other workers.

   Sends an abort signal to other workers.

   Abort flag being true means that a worker can abort and produce whatever result, since its result will not affect the final result of computation. An example of operations using this are `find`, `forall` and `exists` methods.

   Definition Classes
     Signalling

2. #### abstract def isAborted: Boolean

   Checks whether an abort signal has been issued.

   Checks whether an abort signal has been issued.

   Abort flag being true means that a worker can abort and produce whatever result, since its result will not affect the final result of computation. An example of operations using this are `find`, `forall` and `exists` methods.

   returns

     the state of the abort

   Definition Classes
     Signalling

3. #### abstract def tag: Int

   A read only tag specific to the signalling object.

   A read only tag specific to the signalling object. It is used to give specific workers information on the part of the collection being operated on.

   Definition Classes
     Signalling

### Concrete Value Members

1. #### final def !=(arg0: Any): Boolean

   Definition Classes
     AnyRef → Any

2. #### final def ##(): Int

   Definition Classes
     AnyRef → Any

3. #### def +(other: String): String

   Implicit information
     This member is added by an implicit conversion from AtomicIndexFlag to any2stringadd[AtomicIndexFlag] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd

4. #### def ->[B](y: B): (AtomicIndexFlag, B)

   Implicit information
     This member is added by an implicit conversion from AtomicIndexFlag to ArrowAssoc[AtomicIndexFlag] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()

5. #### final def ==(arg0: Any): Boolean

   Definition Classes
     AnyRef → Any

6. #### final def asInstanceOf[T0]: T0

   Definition Classes
     Any

7. #### def clone(): AnyRef

   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @throws( ... )

8. #### def ensuring(cond: (AtomicIndexFlag) ⇒ Boolean, msg: ⇒ Any): AtomicIndexFlag

   Implicit information
     This member is added by an implicit conversion from AtomicIndexFlag to Ensuring[AtomicIndexFlag] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring

9. #### def ensuring(cond: (AtomicIndexFlag) ⇒ Boolean): AtomicIndexFlag

   Implicit information
     This member is added by an implicit conversion from AtomicIndexFlag to Ensuring[AtomicIndexFlag] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring

10. #### def ensuring(cond: Boolean, msg: ⇒ Any): AtomicIndexFlag

    Implicit information
      This member is added by an implicit conversion from AtomicIndexFlag to Ensuring[AtomicIndexFlag] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring

11. #### def ensuring(cond: Boolean): AtomicIndexFlag

    Implicit information
      This member is added by an implicit conversion from AtomicIndexFlag to Ensuring[AtomicIndexFlag] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring

12. #### final def eq(arg0: AnyRef): Boolean

    Definition Classes
      AnyRef

13. #### def equals(arg0: Any): Boolean

    Definition Classes
      AnyRef → Any

14. #### def finalize(): Unit

    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( classOf[java.lang.Throwable] )

15. #### def formatted(fmtstr: String): String

    Returns string formatted according to given `format` string.

    Returns string formatted according to given `format` string. Format strings are as for `String.format` (@see java.lang.String.format).

    Implicit information
      This member is added by an implicit conversion from AtomicIndexFlag to StringFormat[AtomicIndexFlag] performed by method StringFormat in scala.Predef.
    Definition Classes
      StringFormat
    Annotations
      @inline()

16. #### final def getClass(): Class[_]

    Definition Classes
      AnyRef → Any

17. #### def hashCode(): Int

    Definition Classes
      AnyRef → Any

18. #### def indexFlag: Int

    Returns the value of the index flag.

    Returns the value of the index flag.

    The index flag holds an integer which carries some operation-specific meaning. For instance, `takeWhile` operation sets the index flag to the position of the element where the predicate fails. Other workers may check this index against the indices they are working on and return if this index is smaller than their index. Examples of operations using this are `takeWhile`, `dropWhile`, `span` and `indexOf`.

    returns

      the value of the index flag

    Definition Classes
      AtomicIndexFlag → Signalling

19. #### final def isInstanceOf[T0]: Boolean

    Definition Classes
      Any

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 setIndexFlag(f: Int): Unit

    Sets the value of the index flag.

    Sets the value of the index flag.

    The index flag holds an integer which carries some operation-specific meaning. For instance, `takeWhile` operation sets the index flag to the position of the element where the predicate fails. Other workers may check this index against the indices they are working on and return if this index is smaller than their index. Examples of operations using this are `takeWhile`, `dropWhile`, `span` and `indexOf`.

    f

      the value to which the index flag is set.

    Definition Classes
      AtomicIndexFlag → Signalling

24. #### def setIndexFlagIfGreater(f: Int): Unit

    Sets the value of the index flag if argument is greater than current value.

    Sets the value of the index flag if argument is greater than current value. This method does this atomically.

    The index flag holds an integer which carries some operation-specific meaning. For instance, `takeWhile` operation sets the index flag to the position of the element where the predicate fails. Other workers may check this index against the indices they are working on and return if this index is smaller than their index. Examples of operations using this are `takeWhile`, `dropWhile`, `span` and `indexOf`.

    f

      the value to which the index flag is set

    Definition Classes
      AtomicIndexFlag → Signalling

25. #### def setIndexFlagIfLesser(f: Int): Unit

    Sets the value of the index flag if argument is lesser than current value.

    Sets the value of the index flag if argument is lesser than current value. This method does this atomically.

    The index flag holds an integer which carries some operation-specific meaning. For instance, `takeWhile` operation sets the index flag to the position of the element where the predicate fails. Other workers may check this index against the indices they are working on and return if this index is smaller than their index. Examples of operations using this are `takeWhile`, `dropWhile`, `span` and `indexOf`.

    f

      the value to which the index flag is set

    Definition Classes
      AtomicIndexFlag → Signalling

26. #### final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
      AnyRef

27. #### def toString(): String

    Definition Classes
      AnyRef → Any

28. #### final def wait(): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

29. #### final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

30. #### final def wait(arg0: Long): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

31. #### def →[B](y: B): (AtomicIndexFlag, B)

    Implicit information
      This member is added by an implicit conversion from AtomicIndexFlag to ArrowAssoc[AtomicIndexFlag] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
      ArrowAssoc

### Inherited from Signalling

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion any2stringadd from AtomicIndexFlag to any2stringadd[AtomicIndexFlag]

### Inherited by implicit conversion StringFormat from AtomicIndexFlag to StringFormat[AtomicIndexFlag]

### Inherited by implicit conversion Ensuring from AtomicIndexFlag to Ensuring[AtomicIndexFlag]

### Inherited by implicit conversion ArrowAssoc from AtomicIndexFlag to ArrowAssoc[AtomicIndexFlag]

### Ungrouped