<!--
{
  "availability" : [
    "iOS: -",
    "iPadOS: -",
    "macCatalyst: -",
    "macOS: -",
    "tvOS: -",
    "visionOS: -",
    "watchOS: -"
  ],
  "documentType" : "symbol",
  "framework" : "Accelerate",
  "identifier" : "/documentation/Accelerate/SparseNumericFactorOptions",
  "metadataVersion" : "0.1.0",
  "role" : "Structure",
  "symbol" : {
    "kind" : "Structure",
    "modules" : [
      "Accelerate"
    ],
    "preciseIdentifier" : "c:@SA@SparseNumericFactorOptions"
  },
  "title" : "SparseNumericFactorOptions"
}
-->

# SparseNumericFactorOptions

A structure that contains options that affect the numerical stage of a sparse factorization.

```
struct SparseNumericFactorOptions
```

## Overview

[`SparseNumericFactorOptions`](/documentation/Accelerate/SparseNumericFactorOptions) supports the following types of scaling:

|``doc://com.apple.accelerate/documentation/Accelerate/SparseScalingDefault``          |Default scaling — ``doc://com.apple.accelerate/documentation/Accelerate/SparseScalingEquilibriationInf`` if *LDLᵀ*, or no scaling if Cholesky.|
|--------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------|
|``doc://com.apple.accelerate/documentation/Accelerate/SparseScalingUser``             |User scaling if ``doc://com.apple.accelerate/documentation/Accelerate/SparseNumericFactorOptions/scaling`` is nonnull; otherwise, no scaling. |
|``doc://com.apple.accelerate/documentation/Accelerate/SparseScalingEquilibriationInf``|Norm equilibration scaling using infinity norm.                                                                                               |

Note that the system clamps [`pivotTolerance`](/documentation/Accelerate/SparseNumericFactorOptions/pivotTolerance) to range `[0,0.5]`.

## Topics

### Creating a Numeric Factor Options Stucture

[`init(control:scalingMethod:scaling:pivotTolerance:zeroTolerance:)`](/documentation/Accelerate/SparseNumericFactorOptions/init(control:scalingMethod:scaling:pivotTolerance:zeroTolerance:))

Returns a new numeric factor options structure with the specified properties.

[`init()`](/documentation/Accelerate/SparseNumericFactorOptions/init())

Returns a new numeric factor options structure with default properties.

### Instance Properties

[`control`](/documentation/Accelerate/SparseNumericFactorOptions/control)

The flags that control the computation.

[`SparseControl_t`](/documentation/Accelerate/SparseControl_t)

Options that control the computation.

[`scalingMethod`](/documentation/Accelerate/SparseNumericFactorOptions/scalingMethod)

The scaling method.

[`scaling`](/documentation/Accelerate/SparseNumericFactorOptions/scaling)

An array that scales the matrix before factorization.

[`SparseScaling_t`](/documentation/Accelerate/SparseScaling_t)

Options that define which scaling algorithm to use.

[`pivotTolerance`](/documentation/Accelerate/SparseNumericFactorOptions/pivotTolerance)

The pivot tolerance that threshold partial pivoting uses.

[`zeroTolerance`](/documentation/Accelerate/SparseNumericFactorOptions/zeroTolerance)

The zero tolerance that some pivoting modes use.


---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)