API for eigencore
Certified Partial Eigenvalue and Singular Value Computation

Global functions
`%||%` Source code
adjoint Man page Source code
adjoint.eigencore_operator Source code
adjoint_arnoldi_target Source code
alpha_beta Man page Source code
apply_adjoint_operator Source code
apply_operator Source code
arnoldi_left_eigen_contract Source code
arnoldi_plan_controls Source code
arnoldi_ritz_from_eigen Source code
as_operator Man page Source code
as_operator.default Source code
as_operator.eigencore_operator Source code
as_operator.matrix Source code
auto Man page Source code
auto_dense_partial_lanczos Source code
auto_nearest_shift_invert Source code
auto_shift_invert_route Source code
auto_tridiagonal_edge_shift_invert Source code
available_eigen_methods Source code
available_svd_methods Source code
b_orthogonalize Man page Source code
b_reorthogonalize_against Source code
backward_error Man page Source code
basis_workspace Source code
basis_workspace_info Source code
benchmark_block_candidate_lanczos_method Source code
benchmark_eigen_methods Man page Source code
benchmark_rspectra_eigen_opts Source code
benchmark_svd_methods Man page Source code
bidiagonal_matrix Source code
block_golub_kahan_normalize_cached_start Source code
block_golub_kahan_restart_with_random_tail Source code
block_golub_kahan_restart_with_tail Source code
both_ends Man page Source code
center Man page Source code
certificate Man page Source code
certificate_gram Source code
certificates_agree Source code
certify_dense_eigen_r_residual Source code
certify_dense_general_eigen Source code
certify_dense_generalized_pencil Source code
certify_eigen Source code
certify_eigen_operator Source code
certify_eigen_operator_residuals Source code
certify_general_eigen_operator Source code
certify_generalized_pencil_operator Source code
certify_generalized_svd Source code
certify_left_eigen_operator Source code
certify_randomized_svd_projection Source code
certify_svd Source code
certify_svd_operator Source code
certify_svd_operator_cached_av Source code
certify_svd_operator_cached_sides Source code
check_adjoint Man page Source code
cholqr2 Man page Source code
cholqr_once Source code
col_norms Source code
combine_block Source code
common_dtype Source code
complete_zero_singular_triplets Source code
complex_dense_block_apply Source code
complex_dense_matrix_as_operator Source code
compose Man page Source code
crossprod_operator Man page Source code
csc_block_apply Source code
csc_centered_block_apply Source code
csc_matrix_as_operator Source code
csc_native_matrix Source code
default_block_lanczos_max_subspace Source code
default_golub_kahan_initial_subspace Source code
dense_block_apply Source code
dense_eigen_residuals Source code
dense_fallback_budget_bytes Source code
dense_fallback_bytes Source code
dense_fallback_source Source code
dense_generalized_spd_eigen Source code
dense_svd_residuals Source code
diagnostics Man page Source code
diagonal_block_apply Source code
diagonal_matrix_as_operator Source code
eig_full Man page Source code
eig_full_as_complex_matrix Source code
eig_full_certificate Source code
eig_full_dense_input Source code
eig_full_generalized Source code
eig_full_is_hermitian Source code
eig_full_pencil_conditioning Source code
eig_full_resolve_structure Source code
eig_full_result Source code
eig_full_standard Source code
eig_full_validate_square Source code
eig_partial Man page Source code
eigen_backward_scale Source code
eigen_problem Man page Source code
eigencore Man page
eigencore-package Man page
eigencore_preconditioner_info Source code
eigs Man page Source code
eigs_sym Man page Source code
empty_certificate Source code
estimate_operator_frobenius_norm Source code
euclidean Man page Source code
format_bytes Source code
general Man page Source code
generalized_lanczos_dense_transform_operator Source code
generalized_lanczos_diagonal_transform_operator Source code
generalized_lanczos_diagonal_values Source code
generalized_lanczos_label Source code
generalized_lanczos_metric_solve_available Source code
generalized_lanczos_metric_solve_label Source code
generalized_lanczos_metric_solve_metadata Source code
generalized_lanczos_metric_transform_label Source code
generalized_lanczos_native_tridiagonal_solve Source code
generalized_lanczos_plan_controls Source code
generalized_lanczos_prepare_metric_solve Source code
generalized_lanczos_ritz Source code
generalized_lanczos_sparse_tridiagonal_metric_parts Source code
generalized_lanczos_supported Source code
generalized_lanczos_target_supported Source code
generalized_pencil_apply_for_residual Source code
generalized_pencil_certificate_from_residuals Source code
generalized_pencil_certificate_notes Source code
generalized_pencil_dense_residuals Source code
generalized_pencil_operator_residuals Source code
generalized_pencil_validate_dimensions Source code
generalized_pencil_values Source code
generalized_schur Man page Source code
generalized_schur_dense_input Source code
generalized_schur_result Source code
generalized_schur_sort_key Source code
generalized_schur_vectors_flag Source code
generalized_spd_metric_checkable Source code
generalized_spd_metric_known Source code
generalized_svd Man page Source code
generalized_svd_D1 Source code
generalized_svd_D2 Source code
generalized_svd_R Source code
generalized_svd_dense_input Source code
generalized_svd_factors Source code
generalized_svd_result Source code
generalized_svd_validate_dimensions Source code
generalized_svd_validate_tol Source code
golub_kahan Man page Source code
gram_svd_eigen_slice Source code
gram_svd_max_dimension Source code
gram_svd_max_dimension_wide Source code
gram_svd_memory_budget_bytes Source code
gram_svd_min_aspect_ratio Source code
gram_svd_numeric_option Source code
gram_svd_plan_controls Source code
gram_svd_policy Source code
gram_svd_rank_fraction_limit Source code
gram_svd_work_budget_units Source code
gram_svd_zero_tolerance Source code
grid_laplacian_2d_matrix Source code
grid_laplacian_2d_operator Source code
has_native_kernel Source code
hermitian Man page Source code
irlba_lbd_normal_scout_operator Source code
irlba_lbd_normal_scout_start Source code
irlba_lbd_one_sided_warm_start Source code
is_auto_method Source code
is_dense_double_matrix Source code
is_nearest_target Source code
is_square_symmetric Source code
is_transform_method Source code
lanczos Man page Source code
lanczos_plan_controls Source code
lanczos_target_kind Source code
largest Man page Source code
largest_imaginary Man page Source code
largest_magnitude Man page Source code
largest_real Man page Source code
left_vectors Man page Source code
linear_operator Man page Source code
lobpcg Man page Source code
lobpcg_b_orthonormalize Source code
lobpcg_constraints_arg Source code
lobpcg_constraints_plan_reason Source code
lobpcg_plan_controls Source code
lobpcg_prepare_constraints Source code
lobpcg_project_constraints Source code
make_eigen_result Source code
make_svd_result Source code
match_left_eigenvectors Source code
materialize_dense_fallback Source code
materialize_dense_fallbacks Source code
matrix_as_operator Source code
matrix_norm Source code
max_residual_value Source code
method_certificate_field Source code
method_certificate_passed Source code
method_label Source code
method_preconditioner_calls Source code
method_preconditioner_field Source code
method_restart_field Source code
method_values Source code
mgs2 Man page Source code
mgs_once Source code
native_apply_noalloc_check Source code
native_arnoldi_available Source code
native_arnoldi_cycle Source code
native_arnoldi_default_max_subspace Source code
native_arnoldi_general Source code
native_arnoldi_label Source code
native_arnoldi_projected_ritz Source code
native_arnoldi_refined_ritz_vectors Source code
native_arnoldi_ritz Source code
native_b_cholqr2 Source code
native_bidiagonal_svd Source code
native_block_full_subspace_hermitian Source code
native_block_golub_kahan_basis Source code
native_block_golub_kahan_cycle_svd Source code
native_block_golub_kahan_fit Source code
native_block_golub_kahan_retained_cycle_svd Source code
native_block_golub_kahan_retained_restart_abi Source code
native_block_golub_kahan_ritz Source code
native_block_lanczos_hermitian Source code
native_builtin_eigen_certificate Source code
native_builtin_svd_certificate Source code
native_builtin_svd_certificate_cached_av Source code
native_centered_sparse_operator_or_null Source code
native_cholqr2 Source code
native_compose_operator_or_null Source code
native_crossprod_operator_or_null Source code
native_csc_randomized_svd Source code
native_csc_randomized_svd_label Source code
native_csc_randomized_svd_supported Source code
native_dense_complex_general_eigen Source code
native_dense_complex_general_label Source code
native_dense_complex_generalized_hpd_eigen Source code
native_dense_complex_generalized_pencil_eigen Source code
native_dense_complex_generalized_schur Source code
native_dense_complex_hermitian_eigen Source code
native_dense_complex_hermitian_label Source code
native_dense_complex_svd Source code
native_dense_complex_svd_label Source code
native_dense_eigen_certificate Source code
native_dense_generalized_pencil_eigen Source code
native_dense_generalized_pencil_full_label Source code
native_dense_generalized_schur Source code
native_dense_generalized_schur_label Source code
native_dense_generalized_shift_invert_label Source code
native_dense_generalized_shift_invert_lanczos Source code
native_dense_generalized_spd_eigen Source code
native_dense_generalized_spd_full_label Source code
native_dense_generalized_svd Source code
native_dense_generalized_svd_label Source code
native_dense_randomized_svd Source code
native_dense_randomized_svd_label Source code
native_dense_randomized_svd_supported Source code
native_dense_shift_invert_label Source code
native_dense_shift_invert_lanczos Source code
native_dense_svd Source code
native_dense_svd_certificate Source code
native_dense_svd_certificate_cached_av Source code
native_dense_symmetric_eigen Source code
native_dense_symmetric_eigen_dsyevd Source code
native_dense_symmetric_eigen_selected Source code
native_diagonal_b_cholqr2 Source code
native_explicit_operator_or_null Source code
native_generalized_lanczos_hermitian Source code
native_generalized_lanczos_label Source code
native_generalized_lanczos_supported Source code
native_generalized_lanczos_transform_operator Source code
native_generalized_lobpcg_hermitian Source code
native_generalized_lobpcg_label Source code
native_generalized_lobpcg_supported Source code
native_golub_kahan_prefix_diagnostics Source code
native_golub_kahan_ritz Source code
native_golub_kahan_svd Source code
native_golub_kahan_swap_transposed_result Source code
native_golub_kahan_transpose_source Source code
native_gram_svd Source code
native_gram_svd_fast_plan Source code
native_gram_svd_fast_plan_from_dims Source code
native_gram_svd_target_supported Source code
native_interior_golub_kahan_label Source code
native_irlba_lbd_attach_bpro_guard_diagnostics Source code
native_irlba_lbd_attach_lock_diagnostics Source code
native_irlba_lbd_bpro_guard_diagnostics Source code
native_irlba_lbd_deterministic_matrix Source code
native_irlba_lbd_lock_diagnostics Source code
native_irlba_lbd_pad_basis Source code
native_irlba_lbd_pad_subspace Source code
native_irlba_lbd_restart_abi Source code
native_irlba_lbd_restart_diagnostics Source code
native_irlba_lbd_retained_call Source code
native_irlba_lbd_retained_state_from_scout Source code
native_irlba_lbd_retained_svd Source code
native_irlba_lbd_select_vectors Source code
native_kernel_kind Source code
native_lanczos_hermitian Source code
native_lanczos_target_supported Source code
native_lobpcg_hermitian Source code
native_lobpcg_preconditioner_args Source code
native_lobpcg_preconditioner_supported Source code
native_lobpcg_supported Source code
native_lobpcg_target_supported Source code
native_lobpcg_tridiagonal_hermitian Source code
native_matrix_free_arnoldi_available Source code
native_matrix_free_arnoldi_label Source code
native_matrix_free_golub_kahan_available Source code
native_matrix_free_golub_kahan_label Source code
native_matrix_free_interior_golub_kahan_label Source code
native_matrix_free_smallest_golub_kahan_label Source code
native_mgs2 Source code
native_randomized_certificate_from_diagnostics Source code
native_rayleigh_ritz_symmetric Source code
native_refined_arnoldi_available Source code
native_refined_arnoldi_label Source code
native_retained_golub_kahan_diagnostic_label Source code
native_scaled_operator_or_null Source code
native_smallest_golub_kahan_label Source code
native_standard_lobpcg_label Source code
native_sum_operator_or_null Source code
native_svd_certificate_from_diagnostics Source code
native_svd_iteration_target_kind Source code
native_svd_target_kind Source code
native_tridiagonal_eigen Source code
native_tridiagonal_eigen_certificate Source code
native_tridiagonal_eigen_selected Source code
native_tridiagonal_generalized_shift_invert_label Source code
native_tridiagonal_generalized_shift_invert_lanczos Source code
native_tridiagonal_hermitian_label Source code
native_tridiagonal_shift_invert_candidate_sigmas Source code
native_tridiagonal_shift_invert_label Source code
native_tridiagonal_shift_invert_lanczos Source code
native_tridiagonal_shift_invert_lanczos_with_perturbation Source code
native_tridiagonal_shift_invert_retryable_error Source code
nearest Man page Source code
new_certificate Source code
new_eigencore_preconditioner Source code
new_method Source code
new_plan Source code
new_target Source code
normalize_left_eigenvectors Source code
operator_has_nonestimated_norm_provenance Source code
operator_kernel_reason Source code
operator_norm_for_certificate Source code
operator_norm_for_certificate_info Source code
operator_scale Man page Source code
operator_source_matrix Source code
operator_sum Man page Source code
order_indices Source code
orthogonality_loss Man page Source code
orthonormal_completion Source code
path_graph_laplacian_eigenbasis Source code
path_graph_laplacian_matrix Source code
plan_dispatches_arnoldi Source code
plan_dispatches_golub_kahan Source code
plan_dispatches_lanczos Source code
plan_dispatches_lobpcg Source code
plan_dispatches_native_lanczos Source code
plan_dispatches_native_tridiagonal_eigen Source code
plan_dispatches_sparse_general_pencil_arnoldi Source code
plan_dispatches_structured_grid_laplacian_2d Source code
plan_rejects_sparse_general_pencil Source code
plan_solver Man page Source code
plan_solver.eigencore_eigen_problem Source code
plan_solver.eigencore_svd_problem Source code
preconditioner_plan_reason Source code
prepare_shift_invert_operator Source code
print.eigencore_benchmark Source code
print.eigencore_certificate Source code
print.eigencore_eigen_result Source code
print.eigencore_gsvd_result Source code
print.eigencore_operator Source code
print.eigencore_plan Source code
print.eigencore_svd_result Source code
print.eigencore_validation Source code
promoted_block_lanczos_controls Source code
randomized Man page Source code
randomized_svd_apply_pair Source code
randomized_svd_core_decomposition Source code
randomized_svd_lu_normalize Source code
randomized_svd_normalize Source code
rayleigh_ritz Man page Source code
reference_arnoldi_cycle Source code
reference_arnoldi_general Source code
reference_arnoldi_label Source code
reference_arnoldi_ritz Source code
reference_arnoldi_score Source code
reference_arnoldi_score_better Source code
reference_arnoldi_target_supported Source code
reference_block_accept Source code
reference_block_golub_kahan_rr Source code
reference_block_golub_kahan_slice Source code
reference_block_golub_kahan_thick_restart_svd Source code
reference_block_history_frame Source code
reference_block_initial_basis Source code
reference_block_keep_count Source code
reference_block_lanczos_rr Source code
reference_block_lanczos_slice Source code
reference_block_lock_count Source code
reference_block_nonnegative_int Source code
reference_block_positive_int Source code
reference_block_restart_controls Source code
reference_block_subspace_iteration_thick_restart_hermitian Source code
reference_block_take_count Source code
reference_block_unlocked_indices Source code
reference_generalized_lanczos_hermitian Source code
reference_generalized_lobpcg_label Source code
reference_golub_kahan_ritz Source code
reference_golub_kahan_svd Source code
reference_lanczos_hermitian Source code
reference_lanczos_ritz Source code
reference_lobpcg_hermitian Source code
reference_randomized_svd Source code
reference_scalar_subspace_controls Source code
reorthogonalize_against Source code
residuals Man page
residuals.eigencore_certificate Man page Source code
residuals.eigencore_eigen_result Man page Source code
residuals.eigencore_svd_result Man page Source code
result_field Source code
right_vectors Man page Source code
run_eigen_method Source code
run_irlba_lbd_normal_scout_method Source code
run_irlba_lbd_one_sided_method Source code
run_irlba_svd_method Source code
run_rspectra_svd_method Source code
run_svd_method Source code
scale_cols Man page Source code
scale_rows Man page Source code
shift_invert Man page Source code
shift_invert_apply_factory Source code
shift_invert_diagonal_metric_values Source code
shift_invert_double_digest Source code
shift_invert_factorization_cache_info Source code
shift_invert_factorization_cache_key Source code
shift_invert_factorization_cache_merge Source code
shift_invert_factorization_contract Source code
shift_invert_is_native_tridiagonal Source code
shift_invert_metric_factor Source code
shift_invert_operator_fingerprint Source code
shift_invert_plan_label Source code
shift_invert_solver_csc Source code
shift_invert_solver_dense Source code
shift_invert_tridiagonal_parts Source code
shifted_cholesky_preconditioner Man page Source code
shifted_diagonal_preconditioner Man page Source code
shifted_tridiagonal_preconditioner Man page Source code
should_auto_native_generalized_lobpcg Source code
should_auto_reference_generalized_lobpcg Source code
should_use_golub_kahan Source code
should_use_lanczos Source code
should_use_native_dense_hermitian Source code
should_use_native_dense_svd Source code
should_use_native_golub_kahan Source code
should_use_native_gram_svd Source code
should_use_native_lanczos Source code
should_use_native_retained_golub_kahan Source code
should_use_native_tridiagonal_hermitian Source code
smallest Man page Source code
smallest_imaginary Man page Source code
smallest_magnitude Man page Source code
smallest_real Man page Source code
solve.eigencore_eigen_problem Man page Source code
solve.eigencore_svd_problem Man page Source code
solve_eigen_arnoldi Source code
solve_eigen_dense_oracle Source code
solve_eigen_grid_laplacian_2d Source code
solve_eigen_lanczos Source code
solve_eigen_lobpcg Source code
solve_eigen_native_dense_general Source code
solve_eigen_native_dense_hermitian Source code
solve_eigen_native_tridiagonal_hermitian Source code
solve_eigen_sparse_general_pencil_arnoldi Source code
solve_shift_invert_hermitian Source code
solve_svd_dense Source code
solve_svd_golub_kahan Source code
solve_svd_gram Source code
solve_svd_randomized Source code
solve_svd_retained_golub_kahan Source code
source_or_null Source code
sparse_general_pencil_arnoldi_plan_controls Source code
sparse_general_pencil_default_max_subspace Source code
sparse_general_pencil_diagonal_arnoldi_label Source code
sparse_general_pencil_diagonal_arnoldi_supported Source code
sparse_general_pencil_diagonal_values Source code
sparse_general_pencil_transformed_operator Source code
sparse_general_pencil_unsupported_label Source code
sparse_general_pencil_unsupported_message Source code
stop_if_complex_matrix_input Source code
structured_grid_laplacian_2d_controls Source code
structured_grid_laplacian_2d_eigen Source code
structured_grid_laplacian_2d_label Source code
structured_grid_laplacian_2d_metadata Source code
structured_grid_laplacian_2d_supported Source code
svd_backward_scale Source code
svd_native_iterative_plan Source code
svd_partial Man page Source code
svd_plan_controls Source code
svd_plan_uses_unsupported_native_interior Source code
svd_problem Man page Source code
svd_route_explicit_dense_interior_fallback Source code
svd_target_is_interior Source code
svd_target_is_smallest Source code
svd_target_kind Source code
svd_target_plan_controls Source code
svds Man page Source code
symmetric_operator Man page Source code
target_from_which Source code
target_label Source code
target_to_rspectra_which Source code
time_repeated Source code
transform_method_kinds Source code
tridiagonal_edge_shift_sigma Source code
tridiagonal_gershgorin_bounds Source code
tridiagonal_matrix Source code
tridiagonal_shift_pivot_ratio Source code
try_svd_partial_native_gram_fastpath Source code
validate_complex_eigen_plan Source code
validate_complex_svd_plan Source code
validate_eigen_accuracy Man page Source code
validate_metric_symmetric Source code
validate_or_route_svd_target_plan Source code
validate_svd_accuracy Man page Source code
value_error_summary Source code
values Man page Source code
vectors Man page Source code
eigencore documentation built on July 26, 2026, 1:06 a.m.