xgboost4j_2.12 1.2.0 API < Back
 

# Packages

-  package root
  Definition Classes
    root
-  package ml
  Definition Classes
    root
-  package dmlc
  Definition Classes
    ml
-  package xgboost4j
  Definition Classes
    dmlc
-  package scala
  Definition Classes
    xgboost4j
- Booster
- DMatrix
- EvalTrait
- ExternalCheckpointManager
- ObjectiveTrait
- XGBoost

c

ml.dmlc.xgboost4j.scala

# DMatrix 

###

#### class DMatrix extends AnyRef

Linear Supertypes
AnyRef, Any
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. DMatrix
2. AnyRef
3. Any

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Instance Constructors

1.  new DMatrix(data: Array[Float], nrow: Int, ncol: Int, missing: Float)

   create DMatrix from dense matrix

   create DMatrix from dense matrix

   data

     data values

   nrow

     number of rows

   ncol

     number of columns

   missing

     the specified value to represent the missing value

   Annotations
     @throws( classOf[XGBoostError] )
2.  new DMatrix(data: Array[Float], nrow: Int, ncol: Int)

   create DMatrix from dense matrix

   create DMatrix from dense matrix

   data

     data values

   nrow

     number of rows

   ncol

     number of columns

   Annotations
     @throws( classOf[XGBoostError] )
3.  new DMatrix(headers: Array[Long], indices: Array[Int], data: Array[Float], st: SparseType, shapeParam: Int)

   create DMatrix from sparse matrix

   create DMatrix from sparse matrix

   headers

     index to headers (rowHeaders for CSR or colHeaders for CSC)

   indices

     Indices (colIndexs for CSR or rowIndexs for CSC)

   data

     non zero values (sequence by row for CSR or by col for CSC)

   st

     sparse matrix type (CSR or CSC)

   shapeParam

     when st is CSR, it specifies the column number, otherwise it is taken as row number

   Annotations
     @throws( classOf[XGBoostError] )
4.  new DMatrix(dataIter: Iterator[LabeledPoint], cacheInfo: String = null)

   init DMatrix from Iterator of LabeledPoint

   init DMatrix from Iterator of LabeledPoint

   dataIter

     An iterator of LabeledPoint

   cacheInfo

     Cache path information, used for external memory setting, null by default.

   Exceptions thrown

     `XGBoostError` native error

5.  new DMatrix(dataPath: String)

   init DMatrix from file (svmlight format)

   init DMatrix from file (svmlight format)

   dataPath

     path of data file

   Exceptions thrown

     `XGBoostError` native error

6.  new DMatrix(headers: Array[Long], indices: Array[Int], data: Array[Float], st: SparseType)

   create DMatrix from sparse matrix

   create DMatrix from sparse matrix

   headers

     index to headers (rowHeaders for CSR or colHeaders for CSC)

   indices

     Indices (colIndexs for CSR or rowIndexs for CSC)

   data

     non zero values (sequence by row for CSR or by col for CSC)

   st

     sparse matrix type (CSR or CSC)

   Annotations
     @throws( classOf[XGBoostError] ) @deprecated
   Deprecated

### 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[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @native() @throws( ... )
6.  def delete(): Unit
7.  final def eq(arg0: AnyRef): Boolean
   Definition Classes
     AnyRef
8.  def equals(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
9.  def finalize(): Unit
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @throws( classOf[java.lang.Throwable] )
10.  def getBaseMargin: Array[Float]

    get base margin of the DMatrix

    get base margin of the DMatrix

    returns

      base margin

    Annotations
      @throws( classOf[XGBoostError] )
11.  final def getClass(): Class[_]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
12.  def getGroup(): Array[Int]

    Get group sizes of DMatrix (used for ranking)

    Get group sizes of DMatrix (used for ranking)

    Annotations
      @throws( classOf[XGBoostError] )
13.  def getHandle: Long
14.  def getLabel: Array[Float]

    get label values

    get label values

    returns

      label

    Annotations
      @throws( classOf[XGBoostError] )
15.  def getWeight: Array[Float]

    get weight of the DMatrix

    get weight of the DMatrix

    returns

      weights

    Annotations
      @throws( classOf[XGBoostError] )
16.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
17.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
18.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
19.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
20.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
21.  def rowNum: Long

    get the row number of DMatrix

    get the row number of DMatrix

    returns

      number of rows

    Annotations
      @throws( classOf[XGBoostError] )
22.  def saveBinary(filePath: String): Unit

    save DMatrix to filePath

    save DMatrix to filePath

    filePath

      file path

23.  def setBaseMargin(baseMargin: Array[Array[Float]]): Unit

    if specified, xgboost will start from this init margin can be used to specify initial prediction to boost from

    if specified, xgboost will start from this init margin can be used to specify initial prediction to boost from

    baseMargin

      base margin

    Annotations
      @throws( classOf[XGBoostError] )
24.  def setBaseMargin(baseMargin: Array[Float]): Unit

    if specified, xgboost will start from this init margin can be used to specify initial prediction to boost from

    if specified, xgboost will start from this init margin can be used to specify initial prediction to boost from

    baseMargin

      base margin

    Annotations
      @throws( classOf[XGBoostError] )
25.  def setGroup(group: Array[Int]): Unit

    Set group sizes of DMatrix (used for ranking)

    Set group sizes of DMatrix (used for ranking)

    group

      group size as array

    Annotations
      @throws( classOf[XGBoostError] )
26.  def setLabel(labels: Array[Float]): Unit

    set label of dmatrix

    set label of dmatrix

    labels

      labels

    Annotations
      @throws( classOf[XGBoostError] )
27.  def setWeight(weights: Array[Float]): Unit

    set weight of each instance

    set weight of each instance

    weights

      weights

    Annotations
      @throws( classOf[XGBoostError] )
28.  def slice(rowIndex: Array[Int]): DMatrix

    Slice the DMatrix and return a new DMatrix that only contains `rowIndex`.

    Slice the DMatrix and return a new DMatrix that only contains `rowIndex`.

    rowIndex

      row index

    returns

      sliced new DMatrix

    Annotations
      @throws( classOf[XGBoostError] )
29.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
30.  def toString(): String
    Definition Classes
      AnyRef → Any
31.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
32.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
33.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @native() @throws( ... )

### Inherited from AnyRef

### Inherited from Any

### Ungrouped