Type Aliases

The following type aliases are available globally.

  • Alias for backward compatibility.

    Declaration

    Swift

    public typealias XGBoost = Booster

  • Typealias for objective function.

    Declaration

    Swift

    public typealias ObjectiveFunction = (ArrayWithShape<Float>, Data) throws -> (gradient: [Float], hessian: [Float])

  • Typealias for evaluation function.

    Declaration

    Swift

    public typealias EvaluationFunction = (ArrayWithShape<Float>, Data) throws -> (String, String)

  • Typealias for dictionary of cross-validation evaluations.

    Declaration

    Swift

    public typealias CVEvaluation = [String : [Float]]

  • Typealias for function called after CV iteration.

    Declaration

    Swift

    public typealias AfterCVIteration = (Int, CVEvaluation, Bool) throws -> AfterIterationOutput

  • Backward compatible alias for Data

    Declaration

    Swift

    public typealias Data = DMatrix

  • Shape of data structure.

    Declaration

    Swift

    public typealias Shape = [Int]

  • Typealias for underlying XGBoost version.

    Declaration

    Swift

    public typealias Version = (major: Int, minor: Int, patch: Int)

  • Tuple holding length of buffer along with it, so it can be easily read.

    Declaration

    Swift

    public typealias RawModel = (length: UInt64, data: UnsafeMutablePointer<UnsafePointer<Int8>?>)

  • Undocumented

    Declaration

    Swift

    public typealias BufferModel = (length: UInt64, data: UnsafeMutablePointer<UnsafePointer<Int8>?>)

  • Undocumented

    Declaration

    Swift

    public typealias SerializedBuffer = (length: UInt64, data: UnsafeMutablePointer<UnsafePointer<Int8>?>)

  • Dictionary for evaluation in form [data_name: [metric_name: value]]

    Declaration

    Swift

    public typealias Evaluation = [String : [String : String]]

  • Typealias for function called before each iteration at training.

    Declaration

    Swift

    public typealias BeforeIteration = (Booster, Int) throws -> AfterIterationOutput

  • Typealias for function called after each iteration at training.

    Declaration

    Swift

    public typealias AfterIteration = (Booster, Int, Evaluation?, [AfterIterationOutput]) throws -> AfterIterationOutput