libflame  revision_anchor
Functions
FLA_Apply_Q_UT_inc.h File Reference

(r)

Go to the source code of this file.

Functions

FLA_Error FLASH_Apply_Q_UT_inc (FLA_Side side, FLA_Trans trans, FLA_Direct direct, FLA_Store storev, FLA_Obj A, FLA_Obj TW, FLA_Obj W1, FLA_Obj B)
 
FLA_Error FLASH_Apply_Q_UT_inc_create_workspace (FLA_Obj TW, FLA_Obj B, FLA_Obj *W)
 
FLA_Error FLA_Apply_Q_UT_inc_internal (FLA_Side side, FLA_Trans trans, FLA_Direct direct, FLA_Store storev, FLA_Obj A, FLA_Obj TW, FLA_Obj W1, FLA_Obj B, fla_apqutinc_t *cntl)
 
FLA_Error FLA_Apply_Q_UT_inc_lhfc (FLA_Obj A, FLA_Obj TW, FLA_Obj W1, FLA_Obj B, fla_apqutinc_t *cntl)
 
FLA_Error FLA_Apply_Q_UT_inc_lnfc (FLA_Obj A, FLA_Obj TW, FLA_Obj W1, FLA_Obj B, fla_apqutinc_t *cntl)
 

Function Documentation

◆ FLA_Apply_Q_UT_inc_internal()

FLA_Error FLA_Apply_Q_UT_inc_internal ( FLA_Side  side,
FLA_Trans  trans,
FLA_Direct  direct,
FLA_Store  storev,
FLA_Obj  A,
FLA_Obj  TW,
FLA_Obj  W1,
FLA_Obj  B,
fla_apqutinc_t cntl 
)

References FLA_Apply_Q_UT_inc_internal_check(), FLA_Apply_Q_UT_inc_lhfc(), FLA_Apply_Q_UT_inc_lnfc(), and FLA_Check_error_level().

Referenced by FLASH_Apply_Q_UT_inc().

16 {
17  FLA_Error r_val = FLA_SUCCESS;
18 
19  if ( FLA_Check_error_level() == FLA_FULL_ERROR_CHECKING )
20  FLA_Apply_Q_UT_inc_internal_check( side, trans, direct, storev, A, TW, W1, B, cntl );
21 
22  if ( side == FLA_LEFT )
23  {
24  if ( trans == FLA_NO_TRANSPOSE )
25  {
26  if ( direct == FLA_FORWARD )
27  {
28  if ( storev == FLA_COLUMNWISE )
29  r_val = FLA_Apply_Q_UT_inc_lnfc( A, TW, W1, B, cntl );
30  else if ( storev == FLA_ROWWISE )
31  FLA_Check_error_code( FLA_NOT_YET_IMPLEMENTED );
32  }
33  else if ( direct == FLA_BACKWARD )
34  {
35  if ( storev == FLA_COLUMNWISE )
36  FLA_Check_error_code( FLA_NOT_YET_IMPLEMENTED );
37  else if ( storev == FLA_ROWWISE )
38  FLA_Check_error_code( FLA_NOT_YET_IMPLEMENTED );
39  }
40  }
41  else if ( trans == FLA_TRANSPOSE || trans == FLA_CONJ_TRANSPOSE )
42  {
43  if ( direct == FLA_FORWARD )
44  {
45  if ( storev == FLA_COLUMNWISE )
46  r_val = FLA_Apply_Q_UT_inc_lhfc( A, TW, W1, B, cntl );
47  else if ( storev == FLA_ROWWISE )
48  FLA_Check_error_code( FLA_NOT_YET_IMPLEMENTED );
49  }
50  else if ( direct == FLA_BACKWARD )
51  {
52  if ( storev == FLA_COLUMNWISE )
53  FLA_Check_error_code( FLA_NOT_YET_IMPLEMENTED );
54  else if ( storev == FLA_ROWWISE )
55  FLA_Check_error_code( FLA_NOT_YET_IMPLEMENTED );
56  }
57  }
58  }
59  else if ( side == FLA_RIGHT )
60  {
61  if ( trans == FLA_NO_TRANSPOSE )
62  {
63  if ( direct == FLA_FORWARD )
64  {
65  if ( storev == FLA_COLUMNWISE )
66  FLA_Check_error_code( FLA_NOT_YET_IMPLEMENTED );
67  else if ( storev == FLA_ROWWISE )
68  FLA_Check_error_code( FLA_NOT_YET_IMPLEMENTED );
69  }
70  else if ( direct == FLA_BACKWARD )
71  {
72  if ( storev == FLA_COLUMNWISE )
73  FLA_Check_error_code( FLA_NOT_YET_IMPLEMENTED );
74  else if ( storev == FLA_ROWWISE )
75  FLA_Check_error_code( FLA_NOT_YET_IMPLEMENTED );
76  }
77  }
78  else if ( trans == FLA_TRANSPOSE || trans == FLA_CONJ_TRANSPOSE )
79  {
80  if ( direct == FLA_FORWARD )
81  {
82  if ( storev == FLA_COLUMNWISE )
83  FLA_Check_error_code( FLA_NOT_YET_IMPLEMENTED );
84  else if ( storev == FLA_ROWWISE )
85  FLA_Check_error_code( FLA_NOT_YET_IMPLEMENTED );
86  }
87  else if ( direct == FLA_BACKWARD )
88  {
89  if ( storev == FLA_COLUMNWISE )
90  FLA_Check_error_code( FLA_NOT_YET_IMPLEMENTED );
91  else if ( storev == FLA_ROWWISE )
92  FLA_Check_error_code( FLA_NOT_YET_IMPLEMENTED );
93  }
94  }
95  }
96 
97  return r_val;
98 }
int FLA_Error
Definition: FLA_type_defs.h:47
FLA_Error FLA_Apply_Q_UT_inc_lhfc(FLA_Obj A, FLA_Obj TW, FLA_Obj W1, FLA_Obj B, fla_apqutinc_t *cntl)
Definition: FLA_Apply_Q_UT_inc_lhfc.c:13
FLA_Error FLA_Apply_Q_UT_inc_internal_check(FLA_Side side, FLA_Trans trans, FLA_Direct direct, FLA_Store storev, FLA_Obj A, FLA_Obj TW, FLA_Obj W1, FLA_Obj B, fla_apqutinc_t *cntl)
Definition: FLA_Apply_Q_UT_inc_internal_check.c:13
FLA_Error FLA_Apply_Q_UT_inc_lnfc(FLA_Obj A, FLA_Obj TW, FLA_Obj W1, FLA_Obj B, fla_apqutinc_t *cntl)
Definition: FLA_Apply_Q_UT_inc_lnfc.c:13
unsigned int FLA_Check_error_level(void)
Definition: FLA_Check.c:18

◆ FLA_Apply_Q_UT_inc_lhfc()

FLA_Error FLA_Apply_Q_UT_inc_lhfc ( FLA_Obj  A,
FLA_Obj  TW,
FLA_Obj  W1,
FLA_Obj  B,
fla_apqutinc_t cntl 
)

References FLA_Apply_Q_UT_inc_lhfc_blk_var1().

Referenced by FLA_Apply_Q_UT_inc_internal().

14 {
15  return FLA_Apply_Q_UT_inc_lhfc_blk_var1( A, TW, W1, B, cntl );
16 }
FLA_Error FLA_Apply_Q_UT_inc_lhfc_blk_var1(FLA_Obj A, FLA_Obj TW, FLA_Obj W1, FLA_Obj B, fla_apqutinc_t *cntl)
Definition: FLA_Apply_Q_UT_inc_lhfc_blk_var1.c:13

◆ FLA_Apply_Q_UT_inc_lnfc()

FLA_Error FLA_Apply_Q_UT_inc_lnfc ( FLA_Obj  A,
FLA_Obj  TW,
FLA_Obj  W1,
FLA_Obj  B,
fla_apqutinc_t cntl 
)

References FLA_Apply_Q_UT_inc_lnfc_blk_var1().

Referenced by FLA_Apply_Q_UT_inc_internal().

14 {
15  return FLA_Apply_Q_UT_inc_lnfc_blk_var1( A, TW, W1, B, cntl );
16 }
FLA_Error FLA_Apply_Q_UT_inc_lnfc_blk_var1(FLA_Obj A, FLA_Obj TW, FLA_Obj W1, FLA_Obj B, fla_apqutinc_t *cntl)
Definition: FLA_Apply_Q_UT_inc_lnfc_blk_var1.c:13

◆ FLASH_Apply_Q_UT_inc()

FLA_Error FLASH_Apply_Q_UT_inc ( FLA_Side  side,
FLA_Trans  trans,
FLA_Direct  direct,
FLA_Store  storev,
FLA_Obj  A,
FLA_Obj  TW,
FLA_Obj  W1,
FLA_Obj  B 
)

References FLA_Apply_Q_UT_inc_check(), FLA_Apply_Q_UT_inc_internal(), FLA_Check_error_level(), FLASH_Queue_begin(), and FLASH_Queue_end().

20 {
21  FLA_Error r_val;
22 
23  // Check parameters.
24  if ( FLA_Check_error_level() >= FLA_MIN_ERROR_CHECKING )
25  FLA_Apply_Q_UT_inc_check( side, trans, direct, storev, A, TW, W1, B );
26 
27  // Begin a parallel region.
29 
30  // Invoke FLA_Apply_Q_UT_inc_internal() with the standard control tree.
31  r_val = FLA_Apply_Q_UT_inc_internal( side, trans, direct, storev, A, TW, W1, B, flash_apqutinc_cntl );
32 
33  // End the parallel region.
35 
36  return r_val;
37 }
void FLASH_Queue_end(void)
Definition: FLASH_Queue.c:81
int FLA_Error
Definition: FLA_type_defs.h:47
FLA_Error FLA_Apply_Q_UT_inc_internal(FLA_Side side, FLA_Trans trans, FLA_Direct direct, FLA_Store storev, FLA_Obj A, FLA_Obj TW, FLA_Obj W1, FLA_Obj B, fla_apqutinc_t *cntl)
Definition: FLA_Apply_Q_UT_inc_internal.c:13
void FLASH_Queue_begin(void)
Definition: FLASH_Queue.c:59
FLA_Error FLA_Apply_Q_UT_inc_check(FLA_Side side, FLA_Trans trans, FLA_Direct direct, FLA_Store storev, FLA_Obj A, FLA_Obj TW, FLA_Obj W1, FLA_Obj B)
Definition: FLA_Apply_Q_UT_inc_check.c:13
unsigned int FLA_Check_error_level(void)
Definition: FLA_Check.c:18
fla_apqutinc_t * flash_apqutinc_cntl
Definition: FLASH_Apply_Q_UT_inc_cntl_init.c:16

◆ FLASH_Apply_Q_UT_inc_create_workspace()

FLA_Error FLASH_Apply_Q_UT_inc_create_workspace ( FLA_Obj  TW,
FLA_Obj  B,
FLA_Obj W 
)

References FLA_Abort(), FLA_Obj_datatype(), FLA_Obj_width(), FLA_Print_message(), FLASH_Obj_create_ext(), FLASH_Obj_depth(), FLASH_Obj_scalar_length_tl(), and FLASH_Obj_scalar_width_tl().

Referenced by FLASH_QR_UT_inc_solve().

14 {
15  FLA_Datatype datatype;
16  dim_t depth;
17  dim_t b_alg;
18  dim_t b_flash;
19  dim_t m, n;
20 
21  // Query the depth.
22  depth = FLASH_Obj_depth( TW );
23 
24  // *** The current Apply_Q_UT_inc algorithm implemented assumes that
25  // the matrix has a hierarchical depth of 1. We check for that here
26  // because we anticipate that we'll use a more general algorithm in the
27  // future, and we don't want to forget to remove the constraint. ***
28  if ( depth != 1 )
29  {
30  FLA_Print_message( "FLASH_Apply_Q_UT_inc() currently only supports matrices of depth 1",
31  __FILE__, __LINE__ );
32  FLA_Abort();
33  }
34 
35  // Query the datatype of matrix TW.
36  datatype = FLA_Obj_datatype( TW );
37 
38  // Inspect the length of a the top-left element of TW to get the
39  // algorithmic blocksize we'll use throughout the Apply_Q_UT_inc
40  // algorithm.
41  b_alg = FLASH_Obj_scalar_length_tl( TW );
42 
43  // The width of the top-left element gives us the storage blocksize.
44  b_flash = FLASH_Obj_scalar_width_tl( TW );
45 
46  // The element length of W is 1.
47  m = 1;
48 
49  // Query the element (not scalar) width of the right-hand side
50  // matrix B. This is done so we can create W with full blocks for the
51  // right "edge cases" of B.
52  n = FLA_Obj_width( B );
53 
54  // Create hierarchical matrix W.
55  FLASH_Obj_create_ext( datatype, m * b_alg, n * b_flash,
56  depth, &b_alg, &b_flash,
57  W );
58 
59  return FLA_SUCCESS;
60 }
unsigned long dim_t
Definition: FLA_type_defs.h:71
dim_t FLASH_Obj_depth(FLA_Obj H)
Definition: FLASH_Obj.c:20
FLA_Error FLASH_Obj_create_ext(FLA_Datatype datatype, dim_t m, dim_t n, dim_t depth, dim_t *b_m, dim_t *b_n, FLA_Obj *H)
Definition: FLASH_Obj.c:151
FLA_Datatype FLA_Obj_datatype(FLA_Obj obj)
Definition: FLA_Query.c:13
dim_t FLA_Obj_width(FLA_Obj obj)
Definition: FLA_Query.c:123
dim_t FLASH_Obj_scalar_width_tl(FLA_Obj H)
Definition: FLASH_View.c:737
void FLA_Abort(void)
Definition: FLA_Error.c:248
void FLA_Print_message(char *str, char *file, int line)
Definition: FLA_Error.c:234
int FLA_Datatype
Definition: FLA_type_defs.h:49
dim_t FLASH_Obj_scalar_length_tl(FLA_Obj H)
Definition: FLASH_View.c:723