# PolynomialExpansion

### Related Docs: object PolynomialExpansion | package feature

#### class PolynomialExpansion extends UnaryTransformer[Vector, Vector, PolynomialExpansion] with DefaultParamsWritable

Perform feature expansion in a polynomial space. As said in wikipedia of Polynomial Expansion, which is available at http://en.wikipedia.org/wiki/Polynomial_expansion, "In mathematics, an expansion of a product of sums expresses it as a sum of products by using the fact that multiplication distributes over addition". Take a 2-variable feature vector as an example: `(x, y)`, if we want to expand it with degree 2, then we get `(x, x * x, y, x * y, y * y)`.

Annotations
@Since( "1.4.0" )
Source
PolynomialExpansion.scala
Linear Supertypes
DefaultParamsWritable, MLWritable, UnaryTransformer[Vector, Vector, PolynomialExpansion], HasOutputCol, HasInputCol, Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
1. Grouped
2. Alphabetic
3. By Inheritance
Inherited
1. PolynomialExpansion
2. DefaultParamsWritable
3. MLWritable
4. UnaryTransformer
5. HasOutputCol
6. HasInputCol
7. Transformer
8. PipelineStage
9. Logging
10. Params
11. Serializable
12. Serializable
13. Identifiable
14. AnyRef
15. Any
1. Hide All
2. Show All
Visibility
1. Public
2. All

### Instance Constructors

1. #### new PolynomialExpansion()

Annotations
@Since( "1.4.0" )
2. #### new PolynomialExpansion(uid: String)

Annotations
@Since( "1.4.0" )

### 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[_]): PolynomialExpansion.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): PolynomialExpansion

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
PolynomialExpansionUnaryTransformerTransformerPipelineStageParams
Annotations
@Since( "1.4.1" )
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. #### def createTransformFunc: (Vector) ⇒ Vector

Creates the transform function using the given param map.

Creates the transform function using the given param map. The input param map already takes account of the embedded param map. So the param values should be determined solely by the input param map.

Attributes
protected
Definition Classes
PolynomialExpansionUnaryTransformer
11. #### 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
12. #### val degree: IntParam

The polynomial degree to expand, which should be >= 1.

The polynomial degree to expand, which should be >= 1. A value of 1 means no expansion. Default: 2

Annotations
@Since( "1.4.0" )
13. #### final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
14. #### def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
15. #### 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
16. #### def explainParams(): String

Explains all params of this instance.

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

Definition Classes
Params
17. #### final def extractParamMap(): ParamMap

extractParamMap with no extra values.

extractParamMap with no extra values.

Definition Classes
Params
18. #### 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
19. #### def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
20. #### 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
21. #### final def getClass(): Class[_]

Definition Classes
AnyRef → Any
22. #### 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
23. #### def getDegree: Int

Annotations
@Since( "1.4.0" )
24. #### final def getInputCol: String

Definition Classes
HasInputCol
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. #### final def getOutputCol: String

Definition Classes
HasOutputCol
27. #### def getParam(paramName: String): Param[Any]

Gets a param by its name.

Gets a param by its name.

Definition Classes
Params
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. #### def initializeLogIfNecessary(isInterpreter: Boolean): Unit

Attributes
protected
Definition Classes
Logging
32. #### final val inputCol: Param[String]

Param for input column name.

Param for input column name.

Definition Classes
HasInputCol
33. #### 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
34. #### final def isInstanceOf[T0]: Boolean

Definition Classes
Any
35. #### final def isSet(param: Param[_]): Boolean

Checks whether a param is explicitly set.

Checks whether a param is explicitly set.

Definition Classes
Params
36. #### def isTraceEnabled(): Boolean

Attributes
protected
Definition Classes
Logging
37. #### def log: Logger

Attributes
protected
Definition Classes
Logging
38. #### def logDebug(msg: ⇒ String, throwable: Throwable): Unit

Attributes
protected
Definition Classes
Logging
39. #### def logDebug(msg: ⇒ String): Unit

Attributes
protected
Definition Classes
Logging
40. #### def logError(msg: ⇒ String, throwable: Throwable): Unit

Attributes
protected
Definition Classes
Logging
41. #### def logError(msg: ⇒ String): Unit

Attributes
protected
Definition Classes
Logging
42. #### def logInfo(msg: ⇒ String, throwable: Throwable): Unit

Attributes
protected
Definition Classes
Logging
43. #### def logInfo(msg: ⇒ String): Unit

Attributes
protected
Definition Classes
Logging
44. #### def logName: String

Attributes
protected
Definition Classes
Logging
45. #### def logTrace(msg: ⇒ String, throwable: Throwable): Unit

Attributes
protected
Definition Classes
Logging
46. #### def logTrace(msg: ⇒ String): Unit

Attributes
protected
Definition Classes
Logging
47. #### def logWarning(msg: ⇒ String, throwable: Throwable): Unit

Attributes
protected
Definition Classes
Logging
48. #### def logWarning(msg: ⇒ String): Unit

Attributes
protected
Definition Classes
Logging
49. #### final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
50. #### final def notify(): Unit

Definition Classes
AnyRef
51. #### final def notifyAll(): Unit

Definition Classes
AnyRef
52. #### final val outputCol: Param[String]

Param for output column name.

Param for output column name.

Definition Classes
HasOutputCol
53. #### def outputDataType: DataType

Returns the data type of the output column.

Returns the data type of the output column.

Attributes
protected
Definition Classes
PolynomialExpansionUnaryTransformer
54. #### 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.

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

Definition Classes
Params
55. #### def save(path: String): Unit

Saves this ML instance to the input path, a shortcut of `write.save(path)`.

Saves this ML instance to the input path, a shortcut of `write.save(path)`.

Definition Classes
MLWritable
Annotations
@Since( "1.6.0" ) @throws( ... )
56. #### final def set(paramPair: ParamPair[_]): PolynomialExpansion.this.type

Sets a parameter in the embedded param map.

Sets a parameter in the embedded param map.

Attributes
protected
Definition Classes
Params
57. #### final def set(param: String, value: Any): PolynomialExpansion.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
58. #### final def set[T](param: Param[T], value: T): PolynomialExpansion.this.type

Sets a parameter in the embedded param map.

Sets a parameter in the embedded param map.

Definition Classes
Params
59. #### final def setDefault(paramPairs: ParamPair[_]*): PolynomialExpansion.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
60. #### final def setDefault[T](param: Param[T], value: T): PolynomialExpansion.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
61. #### def setDegree(value: Int): PolynomialExpansion.this.type

Annotations
@Since( "1.4.0" )
62. #### def setInputCol(value: String): PolynomialExpansion

Definition Classes
UnaryTransformer
63. #### def setOutputCol(value: String): PolynomialExpansion

Definition Classes
UnaryTransformer
64. #### final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
65. #### def toString(): String

Definition Classes
Identifiable → AnyRef → Any
66. #### def transform(dataset: Dataset[_]): DataFrame

Transforms the input dataset.

Transforms the input dataset.

Definition Classes
UnaryTransformerTransformer
67. #### def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

Transforms the dataset with provided parameter map as additional parameters.

Transforms the dataset with provided parameter map as additional parameters.

dataset

input dataset

paramMap

additional parameters, overwrite embedded params

returns

transformed dataset

Definition Classes
Transformer
Annotations
@Since( "2.0.0" )
68. #### def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame

Transforms the dataset with optional parameters

Transforms the dataset with optional parameters

dataset

input dataset

firstParamPair

the first param pair, overwrite embedded params

otherParamPairs

other param pairs, overwrite embedded params

returns

transformed dataset

Definition Classes
Transformer
Annotations
@Since( "2.0.0" ) @varargs()
69. #### def transformSchema(schema: StructType): StructType

:: DeveloperApi ::

:: DeveloperApi ::

Check transform validity and derive the output schema from the input schema.

Typical implementation should first conduct verification on schema change and parameter validity, including complex parameter interaction checks.

Definition Classes
UnaryTransformerPipelineStage
70. #### def transformSchema(schema: StructType, logging: Boolean): StructType

:: DeveloperApi ::

:: DeveloperApi ::

Derives the output schema from the input schema and parameters, optionally with logging.

This should be optimistic. If it is unclear whether the schema will be valid, then it should be assumed valid until proven otherwise.

Attributes
protected
Definition Classes
PipelineStage
Annotations
@DeveloperApi()
71. #### 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
PolynomialExpansionIdentifiable
Annotations
@Since( "1.4.0" )
72. #### def validateInputType(inputType: DataType): Unit

Validates the input type.

Validates the input type. Throw an exception if it is invalid.

Attributes
protected
Definition Classes
UnaryTransformer
73. #### final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
74. #### final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
75. #### final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
76. #### def write: MLWriter

Returns an MLWriter instance for this ML instance.

Returns an MLWriter instance for this ML instance.

Definition Classes
DefaultParamsWritableMLWritable

### Deprecated Value Members

1. #### def validateParams(): Unit

Validates parameter values stored internally.

Validates parameter values stored internally. Raise an exception if any parameter value is invalid.

This only needs to check for interactions between parameters. Parameter value checks which do not depend on other parameters are handled by `Param.validate()`. This method does not handle input/output column parameters; those are checked during schema validation.

Definition Classes
Params
Annotations
@deprecated
Deprecated

(Since version 2.0.0) Will be removed in 2.1.0. Checks should be merged into transformSchema.

### Parameters

A list of (hyper-)parameter keys this algorithm can take. Users can set and get the parameter values through setters and getters, respectively.