la_least_squares::solve_lstsq Interface Reference

Public Member Functions
subroutine	la_ssolve_lstsq_one (a, b, x, real_storage, int_storage, cond, singvals, overwrite_a, rank, err)
	Compute the least-squares solution to a real(sp) system of linear equations Ax = B into x.
subroutine	la_dsolve_lstsq_one (a, b, x, real_storage, int_storage, cond, singvals, overwrite_a, rank, err)
	Compute the least-squares solution to a real(dp) system of linear equations Ax = B into x.
subroutine	la_qsolve_lstsq_one (a, b, x, real_storage, int_storage, cond, singvals, overwrite_a, rank, err)
	Compute the least-squares solution to a real(qp) system of linear equations Ax = B into x.
subroutine	la_csolve_lstsq_one (a, b, x, real_storage, int_storage, cmpl_storage, cond, singvals, overwrite_a, rank, err)
	Compute the least-squares solution to a complex(sp) system of linear equations Ax = B into x.
subroutine	la_zsolve_lstsq_one (a, b, x, real_storage, int_storage, cmpl_storage, cond, singvals, overwrite_a, rank, err)
	Compute the least-squares solution to a complex(dp) system of linear equations Ax = B into x.
subroutine	la_wsolve_lstsq_one (a, b, x, real_storage, int_storage, cmpl_storage, cond, singvals, overwrite_a, rank, err)
	Compute the least-squares solution to a complex(qp) system of linear equations Ax = B into x.
subroutine	la_ssolve_lstsq_multiple (a, b, x, real_storage, int_storage, cond, singvals, overwrite_a, rank, err)
	Compute the least-squares solution to a real(sp) system of linear equations Ax = B into x.
subroutine	la_dsolve_lstsq_multiple (a, b, x, real_storage, int_storage, cond, singvals, overwrite_a, rank, err)
	Compute the least-squares solution to a real(dp) system of linear equations Ax = B into x.
subroutine	la_qsolve_lstsq_multiple (a, b, x, real_storage, int_storage, cond, singvals, overwrite_a, rank, err)
	Compute the least-squares solution to a real(qp) system of linear equations Ax = B into x.
subroutine	la_csolve_lstsq_multiple (a, b, x, real_storage, int_storage, cmpl_storage, cond, singvals, overwrite_a, rank, err)
	Compute the least-squares solution to a complex(sp) system of linear equations Ax = B into x.
subroutine	la_zsolve_lstsq_multiple (a, b, x, real_storage, int_storage, cmpl_storage, cond, singvals, overwrite_a, rank, err)
	Compute the least-squares solution to a complex(dp) system of linear equations Ax = B into x.
subroutine	la_wsolve_lstsq_multiple (a, b, x, real_storage, int_storage, cmpl_storage, cond, singvals, overwrite_a, rank, err)
	Compute the least-squares solution to a complex(qp) system of linear equations Ax = B into x.

Member Function/Subroutine Documentation

la_csolve_lstsq_multiple()

subroutine la_least_squares::solve_lstsq::la_csolve_lstsq_multiple	(	complex(sp), dimension(:,:), intent(inout), target	a,
		complex(sp), dimension(:,:), intent(in)	b,
		complex(sp), dimension(:,:), intent(inout), target, contiguous	x,
		real(sp), dimension(:), intent(inout), optional, target	real_storage,
		integer(ilp), dimension(:), intent(inout), optional, target	int_storage,
		complex(sp), dimension(:), intent(inout), optional, target	cmpl_storage,
		real(sp), intent(in), optional	cond,
		real(sp), dimension(:), intent(out), optional, target	singvals,
		logical(lk), intent(in), optional	overwrite_a,
		integer(ilp), intent(out), optional	rank,
		type(la_state), intent(out), optional	err )

Compute the least-squares solution to a complex(sp) system of linear equations Ax = B into x.

Parameters

[in,out]	a	Input matrix a[n,n]
[in]	b	Right hand side vector or array, b[n] or b[n,nrhs]
[in,out]	x	Result array/matrix x[n] or x[n,nrhs]
[in,out]	real_storage	[optional] real working storage space
[in,out]	int_storage	[optional] integer working storage space
[in,out]	cmpl_storage	[optional] complex working storage space
[in]	cond	[optional] cutoff for rank evaluation: singular values s(i)<=cond*maxval(s) are considered 0.
[out]	singvals	[optional] list of singular values [min(m,n)], in descending magnitude order, returned by the SVD
[in]	overwrite_a	[optional] Can A,b data be overwritten and destroyed?
[out]	rank	[optional] Return rank of A
[out]	err	[optional] state return flag. On error if not requested, the code will stop

la_csolve_lstsq_one()

subroutine la_least_squares::solve_lstsq::la_csolve_lstsq_one	(	complex(sp), dimension(:,:), intent(inout), target	a,
		complex(sp), dimension(:), intent(in)	b,
		complex(sp), dimension(:), intent(inout), target, contiguous	x,
		real(sp), dimension(:), intent(inout), optional, target	real_storage,
		integer(ilp), dimension(:), intent(inout), optional, target	int_storage,
		complex(sp), dimension(:), intent(inout), optional, target	cmpl_storage,
		real(sp), intent(in), optional	cond,
		real(sp), dimension(:), intent(out), optional, target	singvals,
		logical(lk), intent(in), optional	overwrite_a,
		integer(ilp), intent(out), optional	rank,
		type(la_state), intent(out), optional	err )

Compute the least-squares solution to a complex(sp) system of linear equations Ax = B into x.

Parameters

[in,out]	a	Input matrix a[n,n]
[in]	b	Right hand side vector or array, b[n] or b[n,nrhs]
[in,out]	x	Result array/matrix x[n] or x[n,nrhs]
[in,out]	real_storage	[optional] real working storage space
[in,out]	int_storage	[optional] integer working storage space
[in,out]	cmpl_storage	[optional] complex working storage space
[in]	cond	[optional] cutoff for rank evaluation: singular values s(i)<=cond*maxval(s) are considered 0.
[out]	singvals	[optional] list of singular values [min(m,n)], in descending magnitude order, returned by the SVD
[in]	overwrite_a	[optional] Can A,b data be overwritten and destroyed?
[out]	rank	[optional] Return rank of A
[out]	err	[optional] state return flag. On error if not requested, the code will stop

la_dsolve_lstsq_multiple()

subroutine la_least_squares::solve_lstsq::la_dsolve_lstsq_multiple	(	real(dp), dimension(:,:), intent(inout), target	a,
		real(dp), dimension(:,:), intent(in)	b,
		real(dp), dimension(:,:), intent(inout), target, contiguous	x,
		real(dp), dimension(:), intent(inout), optional, target	real_storage,
		integer(ilp), dimension(:), intent(inout), optional, target	int_storage,
		real(dp), intent(in), optional	cond,
		real(dp), dimension(:), intent(out), optional, target	singvals,
		logical(lk), intent(in), optional	overwrite_a,
		integer(ilp), intent(out), optional	rank,
		type(la_state), intent(out), optional	err )

Compute the least-squares solution to a real(dp) system of linear equations Ax = B into x.

Parameters

[in,out]	a	Input matrix a[n,n]
[in]	b	Right hand side vector or array, b[n] or b[n,nrhs]
[in,out]	x	Result array/matrix x[n] or x[n,nrhs]
[in,out]	real_storage	[optional] real working storage space
[in,out]	int_storage	[optional] integer working storage space
[in]	cond	[optional] cutoff for rank evaluation: singular values s(i)<=cond*maxval(s) are considered 0.
[out]	singvals	[optional] list of singular values [min(m,n)], in descending magnitude order, returned by the SVD
[in]	overwrite_a	[optional] Can A,b data be overwritten and destroyed?
[out]	rank	[optional] Return rank of A
[out]	err	[optional] state return flag. On error if not requested, the code will stop

la_dsolve_lstsq_one()

subroutine la_least_squares::solve_lstsq::la_dsolve_lstsq_one	(	real(dp), dimension(:,:), intent(inout), target	a,
		real(dp), dimension(:), intent(in)	b,
		real(dp), dimension(:), intent(inout), target, contiguous	x,
		real(dp), dimension(:), intent(inout), optional, target	real_storage,
		integer(ilp), dimension(:), intent(inout), optional, target	int_storage,
		real(dp), intent(in), optional	cond,
		real(dp), dimension(:), intent(out), optional, target	singvals,
		logical(lk), intent(in), optional	overwrite_a,
		integer(ilp), intent(out), optional	rank,
		type(la_state), intent(out), optional	err )

Compute the least-squares solution to a real(dp) system of linear equations Ax = B into x.

Parameters

[in,out]	a	Input matrix a[n,n]
[in]	b	Right hand side vector or array, b[n] or b[n,nrhs]
[in,out]	x	Result array/matrix x[n] or x[n,nrhs]
[in,out]	real_storage	[optional] real working storage space
[in,out]	int_storage	[optional] integer working storage space
[in]	cond	[optional] cutoff for rank evaluation: singular values s(i)<=cond*maxval(s) are considered 0.
[out]	singvals	[optional] list of singular values [min(m,n)], in descending magnitude order, returned by the SVD
[in]	overwrite_a	[optional] Can A,b data be overwritten and destroyed?
[out]	rank	[optional] Return rank of A
[out]	err	[optional] state return flag. On error if not requested, the code will stop

la_qsolve_lstsq_multiple()

subroutine la_least_squares::solve_lstsq::la_qsolve_lstsq_multiple	(	real(qp), dimension(:,:), intent(inout), target	a,
		real(qp), dimension(:,:), intent(in)	b,
		real(qp), dimension(:,:), intent(inout), target, contiguous	x,
		real(qp), dimension(:), intent(inout), optional, target	real_storage,
		integer(ilp), dimension(:), intent(inout), optional, target	int_storage,
		real(qp), intent(in), optional	cond,
		real(qp), dimension(:), intent(out), optional, target	singvals,
		logical(lk), intent(in), optional	overwrite_a,
		integer(ilp), intent(out), optional	rank,
		type(la_state), intent(out), optional	err )

Compute the least-squares solution to a real(qp) system of linear equations Ax = B into x.

Parameters

[in,out]	a	Input matrix a[n,n]
[in]	b	Right hand side vector or array, b[n] or b[n,nrhs]
[in,out]	x	Result array/matrix x[n] or x[n,nrhs]
[in,out]	real_storage	[optional] real working storage space
[in,out]	int_storage	[optional] integer working storage space
[in]	cond	[optional] cutoff for rank evaluation: singular values s(i)<=cond*maxval(s) are considered 0.
[out]	singvals	[optional] list of singular values [min(m,n)], in descending magnitude order, returned by the SVD
[in]	overwrite_a	[optional] Can A,b data be overwritten and destroyed?
[out]	rank	[optional] Return rank of A
[out]	err	[optional] state return flag. On error if not requested, the code will stop

la_qsolve_lstsq_one()

subroutine la_least_squares::solve_lstsq::la_qsolve_lstsq_one	(	real(qp), dimension(:,:), intent(inout), target	a,
		real(qp), dimension(:), intent(in)	b,
		real(qp), dimension(:), intent(inout), target, contiguous	x,
		real(qp), dimension(:), intent(inout), optional, target	real_storage,
		integer(ilp), dimension(:), intent(inout), optional, target	int_storage,
		real(qp), intent(in), optional	cond,
		real(qp), dimension(:), intent(out), optional, target	singvals,
		logical(lk), intent(in), optional	overwrite_a,
		integer(ilp), intent(out), optional	rank,
		type(la_state), intent(out), optional	err )

Compute the least-squares solution to a real(qp) system of linear equations Ax = B into x.

Parameters

[in,out]	a	Input matrix a[n,n]
[in]	b	Right hand side vector or array, b[n] or b[n,nrhs]
[in,out]	x	Result array/matrix x[n] or x[n,nrhs]
[in,out]	real_storage	[optional] real working storage space
[in,out]	int_storage	[optional] integer working storage space
[in]	cond	[optional] cutoff for rank evaluation: singular values s(i)<=cond*maxval(s) are considered 0.
[out]	singvals	[optional] list of singular values [min(m,n)], in descending magnitude order, returned by the SVD
[in]	overwrite_a	[optional] Can A,b data be overwritten and destroyed?
[out]	rank	[optional] Return rank of A
[out]	err	[optional] state return flag. On error if not requested, the code will stop

la_ssolve_lstsq_multiple()

subroutine la_least_squares::solve_lstsq::la_ssolve_lstsq_multiple	(	real(sp), dimension(:,:), intent(inout), target	a,
		real(sp), dimension(:,:), intent(in)	b,
		real(sp), dimension(:,:), intent(inout), target, contiguous	x,
		real(sp), dimension(:), intent(inout), optional, target	real_storage,
		integer(ilp), dimension(:), intent(inout), optional, target	int_storage,
		real(sp), intent(in), optional	cond,
		real(sp), dimension(:), intent(out), optional, target	singvals,
		logical(lk), intent(in), optional	overwrite_a,
		integer(ilp), intent(out), optional	rank,
		type(la_state), intent(out), optional	err )

Compute the least-squares solution to a real(sp) system of linear equations Ax = B into x.

Parameters

[in,out]	a	Input matrix a[n,n]
[in]	b	Right hand side vector or array, b[n] or b[n,nrhs]
[in,out]	x	Result array/matrix x[n] or x[n,nrhs]
[in,out]	real_storage	[optional] real working storage space
[in,out]	int_storage	[optional] integer working storage space
[in]	cond	[optional] cutoff for rank evaluation: singular values s(i)<=cond*maxval(s) are considered 0.
[out]	singvals	[optional] list of singular values [min(m,n)], in descending magnitude order, returned by the SVD
[in]	overwrite_a	[optional] Can A,b data be overwritten and destroyed?
[out]	rank	[optional] Return rank of A
[out]	err	[optional] state return flag. On error if not requested, the code will stop

la_ssolve_lstsq_one()

subroutine la_least_squares::solve_lstsq::la_ssolve_lstsq_one	(	real(sp), dimension(:,:), intent(inout), target	a,
		real(sp), dimension(:), intent(in)	b,
		real(sp), dimension(:), intent(inout), target, contiguous	x,
		real(sp), dimension(:), intent(inout), optional, target	real_storage,
		integer(ilp), dimension(:), intent(inout), optional, target	int_storage,
		real(sp), intent(in), optional	cond,
		real(sp), dimension(:), intent(out), optional, target	singvals,
		logical(lk), intent(in), optional	overwrite_a,
		integer(ilp), intent(out), optional	rank,
		type(la_state), intent(out), optional	err )

Compute the least-squares solution to a real(sp) system of linear equations Ax = B into x.

Parameters

[in,out]	a	Input matrix a[n,n]
[in]	b	Right hand side vector or array, b[n] or b[n,nrhs]
[in,out]	x	Result array/matrix x[n] or x[n,nrhs]
[in,out]	real_storage	[optional] real working storage space
[in,out]	int_storage	[optional] integer working storage space
[in]	cond	[optional] cutoff for rank evaluation: singular values s(i)<=cond*maxval(s) are considered 0.
[out]	singvals	[optional] list of singular values [min(m,n)], in descending magnitude order, returned by the SVD
[in]	overwrite_a	[optional] Can A,b data be overwritten and destroyed?
[out]	rank	[optional] Return rank of A
[out]	err	[optional] state return flag. On error if not requested, the code will stop

la_wsolve_lstsq_multiple()

subroutine la_least_squares::solve_lstsq::la_wsolve_lstsq_multiple	(	complex(qp), dimension(:,:), intent(inout), target	a,
		complex(qp), dimension(:,:), intent(in)	b,
		complex(qp), dimension(:,:), intent(inout), target, contiguous	x,
		real(qp), dimension(:), intent(inout), optional, target	real_storage,
		integer(ilp), dimension(:), intent(inout), optional, target	int_storage,
		complex(qp), dimension(:), intent(inout), optional, target	cmpl_storage,
		real(qp), intent(in), optional	cond,
		real(qp), dimension(:), intent(out), optional, target	singvals,
		logical(lk), intent(in), optional	overwrite_a,
		integer(ilp), intent(out), optional	rank,
		type(la_state), intent(out), optional	err )

Compute the least-squares solution to a complex(qp) system of linear equations Ax = B into x.

Parameters

[in,out]	a	Input matrix a[n,n]
[in]	b	Right hand side vector or array, b[n] or b[n,nrhs]
[in,out]	x	Result array/matrix x[n] or x[n,nrhs]
[in,out]	real_storage	[optional] real working storage space
[in,out]	int_storage	[optional] integer working storage space
[in,out]	cmpl_storage	[optional] complex working storage space
[in]	cond	[optional] cutoff for rank evaluation: singular values s(i)<=cond*maxval(s) are considered 0.
[out]	singvals	[optional] list of singular values [min(m,n)], in descending magnitude order, returned by the SVD
[in]	overwrite_a	[optional] Can A,b data be overwritten and destroyed?
[out]	rank	[optional] Return rank of A
[out]	err	[optional] state return flag. On error if not requested, the code will stop

la_wsolve_lstsq_one()

subroutine la_least_squares::solve_lstsq::la_wsolve_lstsq_one	(	complex(qp), dimension(:,:), intent(inout), target	a,
		complex(qp), dimension(:), intent(in)	b,
		complex(qp), dimension(:), intent(inout), target, contiguous	x,
		real(qp), dimension(:), intent(inout), optional, target	real_storage,
		integer(ilp), dimension(:), intent(inout), optional, target	int_storage,
		complex(qp), dimension(:), intent(inout), optional, target	cmpl_storage,
		real(qp), intent(in), optional	cond,
		real(qp), dimension(:), intent(out), optional, target	singvals,
		logical(lk), intent(in), optional	overwrite_a,
		integer(ilp), intent(out), optional	rank,
		type(la_state), intent(out), optional	err )

Compute the least-squares solution to a complex(qp) system of linear equations Ax = B into x.

Parameters

[in,out]	a	Input matrix a[n,n]
[in]	b	Right hand side vector or array, b[n] or b[n,nrhs]
[in,out]	x	Result array/matrix x[n] or x[n,nrhs]
[in,out]	real_storage	[optional] real working storage space
[in,out]	int_storage	[optional] integer working storage space
[in,out]	cmpl_storage	[optional] complex working storage space
[in]	cond	[optional] cutoff for rank evaluation: singular values s(i)<=cond*maxval(s) are considered 0.
[out]	singvals	[optional] list of singular values [min(m,n)], in descending magnitude order, returned by the SVD
[in]	overwrite_a	[optional] Can A,b data be overwritten and destroyed?
[out]	rank	[optional] Return rank of A
[out]	err	[optional] state return flag. On error if not requested, the code will stop

la_zsolve_lstsq_multiple()

subroutine la_least_squares::solve_lstsq::la_zsolve_lstsq_multiple	(	complex(dp), dimension(:,:), intent(inout), target	a,
		complex(dp), dimension(:,:), intent(in)	b,
		complex(dp), dimension(:,:), intent(inout), target, contiguous	x,
		real(dp), dimension(:), intent(inout), optional, target	real_storage,
		integer(ilp), dimension(:), intent(inout), optional, target	int_storage,
		complex(dp), dimension(:), intent(inout), optional, target	cmpl_storage,
		real(dp), intent(in), optional	cond,
		real(dp), dimension(:), intent(out), optional, target	singvals,
		logical(lk), intent(in), optional	overwrite_a,
		integer(ilp), intent(out), optional	rank,
		type(la_state), intent(out), optional	err )

Compute the least-squares solution to a complex(dp) system of linear equations Ax = B into x.

Parameters

[in,out]	a	Input matrix a[n,n]
[in]	b	Right hand side vector or array, b[n] or b[n,nrhs]
[in,out]	x	Result array/matrix x[n] or x[n,nrhs]
[in,out]	real_storage	[optional] real working storage space
[in,out]	int_storage	[optional] integer working storage space
[in,out]	cmpl_storage	[optional] complex working storage space
[in]	cond	[optional] cutoff for rank evaluation: singular values s(i)<=cond*maxval(s) are considered 0.
[out]	singvals	[optional] list of singular values [min(m,n)], in descending magnitude order, returned by the SVD
[in]	overwrite_a	[optional] Can A,b data be overwritten and destroyed?
[out]	rank	[optional] Return rank of A
[out]	err	[optional] state return flag. On error if not requested, the code will stop

la_zsolve_lstsq_one()

subroutine la_least_squares::solve_lstsq::la_zsolve_lstsq_one	(	complex(dp), dimension(:,:), intent(inout), target	a,
		complex(dp), dimension(:), intent(in)	b,
		complex(dp), dimension(:), intent(inout), target, contiguous	x,
		real(dp), dimension(:), intent(inout), optional, target	real_storage,
		integer(ilp), dimension(:), intent(inout), optional, target	int_storage,
		complex(dp), dimension(:), intent(inout), optional, target	cmpl_storage,
		real(dp), intent(in), optional	cond,
		real(dp), dimension(:), intent(out), optional, target	singvals,
		logical(lk), intent(in), optional	overwrite_a,
		integer(ilp), intent(out), optional	rank,
		type(la_state), intent(out), optional	err )

Compute the least-squares solution to a complex(dp) system of linear equations Ax = B into x.

Parameters

[in,out]	a	Input matrix a[n,n]
[in]	b	Right hand side vector or array, b[n] or b[n,nrhs]
[in,out]	x	Result array/matrix x[n] or x[n,nrhs]
[in,out]	real_storage	[optional] real working storage space
[in,out]	int_storage	[optional] integer working storage space
[in,out]	cmpl_storage	[optional] complex working storage space
[in]	cond	[optional] cutoff for rank evaluation: singular values s(i)<=cond*maxval(s) are considered 0.
[out]	singvals	[optional] list of singular values [min(m,n)], in descending magnitude order, returned by the SVD
[in]	overwrite_a	[optional] Can A,b data be overwritten and destroyed?
[out]	rank	[optional] Return rank of A
[out]	err	[optional] state return flag. On error if not requested, the code will stop

---

The documentation for this interface was generated from the following file:

• la_least_squares.f90