---
title: "SparseSolve(_:_:_:_:)"
framework: accelerate
role: symbol
role_heading: Function
path: "accelerate/sparsesolve(_:_:_:_:)-vewd"
---

# SparseSolve(_:_:_:_:)

Solves the equation AX = B for matrices of double-precision values, treating A as an operator and using the specified iterative method.

## Declaration

```swift
func SparseSolve(_ method: SparseIterativeMethod, _ ApplyOperator: @escaping (Bool, CBLAS_TRANSPOSE, DenseMatrix_Double, DenseMatrix_Double) -> Void, _ B: DenseMatrix_Double, _ X: DenseMatrix_Double) -> SparseIterativeStatus_t
```

## Parameters

- `method`: The iterative method.
- `ApplyOperator`: The apply operator block to run. The block takes the following parameters:
- `B`: The matrix B.
- `X`: The matrix X.

## Return Value

Return Value A SparseIterativeStatus_t enumeration that represents the status of the iterative solve.

## Discussion

Discussion Use this function to solve a system of linear equations using a factored coefficient matrix. In cases where the matrix A isn’t explicitly available or you need control over the multiplication, this function allows you to provide an apply block. The following figure shows two systems of equations where the coefficient matrix is sparse:

The following code solves this system using the least squares minimum residual method: /// Create the coefficient matrix _A_. let rowIndices: [Int32] =    [ 0,  1, 1,  2] let columnIndices: [Int32] = [ 2,  0, 2,  1] let aValues: [Double] =      [10, 20, 5, 50]

let A = SparseConvertFromCoordinate(3, 3,                                     4, 1,                                     SparseAttributes_t(),                                     rowIndices, columnIndices,                                     aValues)

defer {     SparseCleanup(A) }

/// Create the right-hand-side matrix, _B_. var bValues: [Double] = [30, 35, 100,                          300, 350, 1000]

var xValues: [Double] = [0, 0, 0,                          0, 0, 0]

/// Create the apply operator block. func applyOperator(accumulate: Bool,                    trans: CBLAS_TRANSPOSE,                    X: DenseMatrix_Double,                    Y: DenseMatrix_Double) {     switch(accumulate, trans == CblasTrans) {         case (false, false):             SparseMultiply(A, X, Y)         case (false, true):             SparseMultiply(SparseGetTranspose(A), X, Y)         case (true, false):             SparseMultiplyAdd(A, X, Y)         case (true, true):             SparseMultiplyAdd(SparseGetTranspose(A), X, Y)     } }

xValues.withUnsafeMutableBufferPointer { xPtr in     bValues.withUnsafeMutableBufferPointer { bPtr in         let B = DenseMatrix_Double(rowCount: 3,                                    columnCount: 2,                                    columnStride: 3,                                    attributes: SparseAttributes_t(),                                    data: bPtr.baseAddress!)                  let X = DenseMatrix_Double(rowCount: 3,                                    columnCount: 2,                                    columnStride: 3,                                    attributes: SparseAttributes_t(),                                    data: xPtr.baseAddress!)                  let status = SparseSolve(SparseLSMR(),                                  applyOperator,                                  B, X)                  print(status)     } } On return, xValues contains the values [1.0, 2.0, 3.0, 10.0, 20.0, 30.0].

## See Also

### Iterative sparse solve functions

- [SparseSolve(_:_:_:_:)](accelerate/sparsesolve(_:_:_:_:)-3ft19.md)
- [SparseSolve(_:_:_:_:)](accelerate/sparsesolve(_:_:_:_:)-1f00y.md)
- [SparseSolve(_:_:_:_:)](accelerate/sparsesolve(_:_:_:_:)-8mtxu.md)