PrefixSpan

Value Members

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

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

3. final def $[T](param: Param[T]): T

   

   An alias for getOrDefault().

   An alias for getOrDefault().

   Attributes

   protected

   Definition Classes

   Params

4. final def ==(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

5. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

6. final def clear(param: Param[_]): PrefixSpan.this.type

   

   Clears the user-supplied value for the input param.

   Clears the user-supplied value for the input param.

   Definition Classes

   Params

7. def clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

8. def copy(extra: ParamMap): PrefixSpan

   

   Creates a copy of this instance with the same UID and some extra params.

   Creates a copy of this instance with the same UID and some extra params. Subclasses should implement this method and set the return type properly. See defaultCopy().

   Definition Classes

   PrefixSpan → Params

   Annotations

   @Since( "2.4.0" )

9. def copyValues[T <: Params](to: T, extra: ParamMap = ParamMap.empty): T

   

   Copies param values from this instance to another instance for params shared by them.

   Copies param values from this instance to another instance for params shared by them.

   This handles default Params and explicitly set Params separately. Default Params are copied from and to defaultParamMap, and explicitly set Params are copied from and to paramMap. Warning: This implicitly assumes that this Params instance and the target instance share the same set of default Params.

   to

   the target instance, which should work with the same set of default Params as this source instance

   extra

   extra params to be copied to the target's paramMap

   returns

   the target instance with param values copied

   Attributes

   protected

   Definition Classes

   Params

10. final def defaultCopy[T <: Params](extra: ParamMap): T

    

    Default implementation of copy with extra params.

    Default implementation of copy with extra params. It tries to create a new instance with the same UID. Then it copies the embedded and extra parameters over and returns the new instance.

    Attributes

    protected

    Definition Classes

    Params

11. final def eq(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

12. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

13. def explainParam(param: Param[_]): String

    

    Explains a param.

    Explains a param.

    param

    input param, must belong to this instance.

    returns

    a string that contains the input param name, doc, and optionally its default value and the user-supplied value

    Definition Classes

    Params

14. def explainParams(): String

    

    Explains all params of this instance.

    Explains all params of this instance. See explainParam().

    Definition Classes

    Params

15. final def extractParamMap(): ParamMap

    

    extractParamMap with no extra values.

    extractParamMap with no extra values.

    Definition Classes

    Params

16. final def extractParamMap(extra: ParamMap): ParamMap

    

    Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values less than user-supplied values less than extra.

    Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values less than user-supplied values less than extra.

    Definition Classes

    Params

17. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

18. def findFrequentSequentialPatterns(dataset: Dataset[_]): DataFrame

    

    :: Experimental :: Finds the complete set of frequent sequential patterns in the input sequences of itemsets.

    :: Experimental :: Finds the complete set of frequent sequential patterns in the input sequences of itemsets.

    dataset

    A dataset or a dataframe containing a sequence column which is

    ArrayType(ArrayType(T))

    returns

    A DataFrame that contains columns of sequence and corresponding frequency. The schema of it will be:

    • sequence: ArrayType(ArrayType(T)) (T is the item type)
    • freq: Long

    Annotations

    @Since( "2.4.0" )

19. final def get[T](param: Param[T]): Option[T]

    

    Optionally returns the user-supplied value of a param.

    Optionally returns the user-supplied value of a param.

    Definition Classes

    Params

20. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

21. final def getDefault[T](param: Param[T]): Option[T]

    

    Gets the default value of a parameter.

    Gets the default value of a parameter.

    Definition Classes

    Params

22. def getMaxLocalProjDBSize: Long

    
    Annotations

    @Since( "2.4.0" )

23. def getMaxPatternLength: Int

    
    Annotations

    @Since( "2.4.0" )

24. def getMinSupport: Double

    
    Annotations

    @Since( "2.4.0" )

25. final def getOrDefault[T](param: Param[T]): T

    

    Gets the value of a param in the embedded param map or its default value.

    Gets the value of a param in the embedded param map or its default value. Throws an exception if neither is set.

    Definition Classes

    Params

26. def getParam(paramName: String): Param[Any]

    

    Gets a param by its name.

    Gets a param by its name.

    Definition Classes

    Params

27. def getSequenceCol: String

    
    Annotations

    @Since( "2.4.0" )

28. final def hasDefault[T](param: Param[T]): Boolean

    

    Tests whether the input param has a default value set.

    Tests whether the input param has a default value set.

    Definition Classes

    Params

29. def hasParam(paramName: String): Boolean

    

    Tests whether this instance contains a param with a given name.

    Tests whether this instance contains a param with a given name.

    Definition Classes

    Params

30. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

31. final def isDefined(param: Param[_]): Boolean

    

    Checks whether a param is explicitly set or has a default value.

    Checks whether a param is explicitly set or has a default value.

    Definition Classes

    Params

32. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

33. final def isSet(param: Param[_]): Boolean

    

    Checks whether a param is explicitly set.

    Checks whether a param is explicitly set.

    Definition Classes

    Params

34. val maxLocalProjDBSize: LongParam

    

    Param for the maximum number of items (including delimiters used in the internal storage format) allowed in a projected database before local processing (default: 32000000).

    Param for the maximum number of items (including delimiters used in the internal storage format) allowed in a projected database before local processing (default: 32000000). If a projected database exceeds this size, another iteration of distributed prefix growth is run.

    Annotations

    @Since( "2.4.0" )

35. val maxPatternLength: IntParam

    

    Param for the maximal pattern length (default: 10).

    Param for the maximal pattern length (default: 10).

    Annotations

    @Since( "2.4.0" )

36. val minSupport: DoubleParam

    

    Param for the minimal support level (default: 0.1).

    Param for the minimal support level (default: 0.1). Sequential patterns that appear more than (minSupport * size-of-the-dataset) times are identified as frequent sequential patterns.

    Annotations

    @Since( "2.4.0" )

37. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

38. final def notify(): Unit

    

    Definition Classes

    AnyRef

39. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

40. lazy val params: Array[Param[_]]

    

    Returns all params sorted by their names.

    Returns all params sorted by their names. The default implementation uses Java reflection to list all public methods that have no arguments and return Param.

    Definition Classes

    Params

    Note

    Developer should not use this method in constructor because we cannot guarantee that this variable gets initialized before other params.

41. val sequenceCol: Param[String]

    

    Param for the name of the sequence column in dataset (default "sequence"), rows with nulls in this column are ignored.

    Param for the name of the sequence column in dataset (default "sequence"), rows with nulls in this column are ignored.

    Annotations

    @Since( "2.4.0" )

42. final def set(paramPair: ParamPair[_]): PrefixSpan.this.type

    

    Sets a parameter in the embedded param map.

    Sets a parameter in the embedded param map.

    Attributes

    protected

    Definition Classes

    Params

43. final def set(param: String, value: Any): PrefixSpan.this.type

    

    Sets a parameter (by name) in the embedded param map.

    Sets a parameter (by name) in the embedded param map.

    Attributes

    protected

    Definition Classes

    Params

44. final def set[T](param: Param[T], value: T): PrefixSpan.this.type

    

    Sets a parameter in the embedded param map.

    Sets a parameter in the embedded param map.

    Definition Classes

    Params

45. final def setDefault(paramPairs: ParamPair[_]*): PrefixSpan.this.type

    

    Sets default values for a list of params.

    Sets default values for a list of params.

    Note: Java developers should use the single-parameter setDefault. Annotating this with varargs can cause compilation failures due to a Scala compiler bug. See SPARK-9268.

    paramPairs

    a list of param pairs that specify params and their default values to set respectively. Make sure that the params are initialized before this method gets called.

    Attributes

    protected

    Definition Classes

    Params

46. final def setDefault[T](param: Param[T], value: T): PrefixSpan.this.type

    

    Sets a default value for a param.

    Sets a default value for a param.

    param

    param to set the default value. Make sure that this param is initialized before this method gets called.

    value

    the default value

    Attributes

    protected

    Definition Classes

    Params

47. def setMaxLocalProjDBSize(value: Long): PrefixSpan.this.type

    
    Annotations

    @Since( "2.4.0" )

48. def setMaxPatternLength(value: Int): PrefixSpan.this.type

    
    Annotations

    @Since( "2.4.0" )

49. def setMinSupport(value: Double): PrefixSpan.this.type

    
    Annotations

    @Since( "2.4.0" )

50. def setSequenceCol(value: String): PrefixSpan.this.type

    
    Annotations

    @Since( "2.4.0" )

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

    

    Definition Classes

    AnyRef

52. def toString(): String

    

    Definition Classes

    Identifiable → AnyRef → Any

53. val uid: String

    

    An immutable unique ID for the object and its derivatives.

    An immutable unique ID for the object and its derivatives.

    Definition Classes

    PrefixSpan → Identifiable

    Annotations

    @Since( "2.4.0" )

54. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

56. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )