aoclsparse_itsol_?_rci_input() - 5.2 English - 68552

AOCL API Guide (68552)
Document ID
68552
Release Date
2025-12-29
Version
5.2 English
aoclsparse_status aoclsparse_itsol_s_rci_input(aoclsparse_itsol_handle handle, aoclsparse_int n, const float *b)#
aoclsparse_status aoclsparse_itsol_d_rci_input(aoclsparse_itsol_handle handle, aoclsparse_int n, const double *b)#
aoclsparse_status aoclsparse_itsol_c_rci_input(aoclsparse_itsol_handle handle, aoclsparse_int n, const aoclsparse_float_complex *b)#
aoclsparse_status aoclsparse_itsol_z_rci_input(aoclsparse_itsol_handle handle, aoclsparse_int n, const aoclsparse_double_complex *b)#

Store partial data of the linear system of equations into the problem handle.

This function needs to be called before the reverse communication interface iterative solver is called. It registers the linear system’s dimension n, and stores the right-hand side vector b.

Note

This function does not need to be called if the forward communication interface is used.

Parameters:

  • handle – [inout] problem handle. Needs to be initialized by calling aoclsparse_itsol_s_init or aoclsparse_itsol_d_init.

  • n – [in] the number of columns of the (square) linear system matrix.

  • b – [in] the right hand side of the linear system. Must be a vector of size n.

Return values:

  • aoclsparse_status_success – initialization completed successfully.

  • aoclsparse_status_invalid_pointer – one or more of the pointers handle, and b are invalid.

  • aoclsparse_status_wrong_type – handle was initialized with a different floating point precision than requested here, e.g. aoclsparse_itsol_d_init (double precision) was used to initialize handle but aoclsparse_itsol_s_rci_input (single precision) is being called instead of the correct double precision one, aoclsparse_itsol_d_rci_input.

  • aoclsparse_status_invalid_value – n was set to a negative value.

  • aoclsparse_status_memory_error – internal memory allocation error.