FLASH_LQ_UT.c File Reference

(r)

Functions
FLA_Error	FLASH_LQ_UT (FLA_Obj A, FLA_Obj TW)

Variables
fla_lqut_t *	flash_lqut_cntl
fla_lqut_t *	fla_lqut_cntl_leaf

Function Documentation

FLASH_LQ_UT()

FLA_Error FLASH_LQ_UT	(	FLA_Obj	A,
		FLA_Obj	TW
	)

{
  FLA_Error r_val;
  dim_t     b_alg, b_flash;
 
  // Check parameters.
  if ( FLA_Check_error_level() >= FLA_MIN_ERROR_CHECKING )
    FLA_LQ_UT_check( A, TW );
 
  // *** The current hierarchical LQ_UT algorithm assumes that the matrix
  // has a hierarchical depth of 1. We check for that here, because we
  //  anticipate that we'll use a more general algorithm in the future, and
  // we don't want to forget to remove the constraint. ***
  if ( FLASH_Obj_depth( A ) != 1 )
  {
    FLA_Print_message( "FLASH_LQ_UT() currently only supports matrices of depth 1",
                       __FILE__, __LINE__ );
    FLA_Abort();
  }
 
  // Inspect the length of TTL to get the blocksize used by the LQ
  // factorization, which will be our inner blocksize for Apply_Q_UT.
  b_alg   = FLASH_Obj_scalar_length_tl( TW );
  b_flash = FLASH_Obj_scalar_width_tl( TW );
 
  // The traditional (non-incremental) LQ_UT algorithm-by-blocks requires
  // that the algorithmic blocksize be equal to the storage blocksize.
  if ( b_alg != b_flash )
  {
    FLA_Print_message( "FLASH_LQ_UT() requires that b_alg == b_store",
                       __FILE__, __LINE__ );
    FLA_Abort();
  }
 
  // The traditional (non-incremental) LQ_UT algorithm-by-blocks requires
  // that min_dim(A) % b_flash == 0.
  if ( FLASH_Obj_scalar_min_dim( A ) % b_flash != 0 )
  {
    FLA_Print_message( "FLASH_LQ_UT() requires that min_dim( A ) %% b_store == 0",
                       __FILE__, __LINE__ );
    FLA_Abort();
  }
 
  // Begin a parallel region.
  FLASH_Queue_begin();
 
  // Invoke FLA_LQ_UT_internal() with hierarchical control tree.
  r_val = FLA_LQ_UT_internal( A, TW, flash_lqut_cntl );
 
  // End the parallel region.
  FLASH_Queue_end();
 
  return r_val;
}

References FLA_Abort(), FLA_Check_error_level(), FLA_LQ_UT_check(), FLA_LQ_UT_internal(), FLA_Print_message(), flash_lqut_cntl, FLASH_Obj_depth(), FLASH_Obj_scalar_length_tl(), FLASH_Obj_scalar_min_dim(), FLASH_Obj_scalar_width_tl(), FLASH_Queue_begin(), FLASH_Queue_end(), and i.

Variable Documentation

fla_lqut_cntl_leaf

fla_lqut_t* fla_lqut_cntl_leaf

extern

Referenced by FLA_LQ_UT_cntl_finalize(), and FLA_LQ_UT_cntl_init().

flash_lqut_cntl

fla_lqut_t* flash_lqut_cntl

extern

Referenced by FLASH_LQ_UT(), FLASH_LQ_UT_cntl_finalize(), and FLASH_LQ_UT_cntl_init().