MOOCHO (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
RTOp_TOp_set_ele.c
Go to the documentation of this file.
1 /*
2 // @HEADER
3 // ***********************************************************************
4 //
5 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
6 // Copyright (2003) Sandia Corporation
7 //
8 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
9 // license for use of this work by or on behalf of the U.S. Government.
10 //
11 // Redistribution and use in source and binary forms, with or without
12 // modification, are permitted provided that the following conditions are
13 // met:
14 //
15 // 1. Redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright
19 // notice, this list of conditions and the following disclaimer in the
20 // documentation and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of the Corporation nor the names of the
23 // contributors may be used to endorse or promote products derived from
24 // this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov)
39 //
40 // ***********************************************************************
41 // @HEADER
42 */
43 
44 #include "RTOp_TOp_set_ele.h"
46 #include "RTOp_obj_null_vtbl.h"
47 
48 /* Implementation functions for RTOp_RTOp */
49 
51  const struct RTOp_RTOp_vtbl_t* vtbl, const void* obj_data
52  , const int num_vecs, const struct RTOp_SubVector vecs[]
53  , const int num_targ_vecs, const struct RTOp_MutableSubVector targ_vecs[]
54  , RTOp_ReductTarget targ_obj )
55 {
56  const struct RTOp_value_index_type *val_ind = NULL;
57  RTOp_value_type alpha;
59  RTOp_index_type global_offset;
60  RTOp_index_type z_sub_dim;
61  RTOp_value_type *z_val = NULL;
62  ptrdiff_t z_val_s;
63 
64  /* */
65  /* Validate the input */
66  /* */
67  if( num_vecs != 0 || vecs != NULL )
69  if( num_targ_vecs != 1 || targ_vecs == NULL )
71 
72  /* */
73  /* Get pointers to data */
74  /* */
75 
76  /* alpha, i */
77  val_ind = (const struct RTOp_value_index_type*)obj_data;
78  alpha = val_ind->value;
79  i = val_ind->index;
80 
81  /* z */
82  global_offset = targ_vecs[0].global_offset;
83  z_sub_dim = targ_vecs[0].sub_dim;
84  z_val = targ_vecs[0].values;
85  z_val_s = targ_vecs[0].values_stride;
86 
87  /* */
88  /* Set the element? */
89  /* */
90 
91  if( i < global_offset + 1 || global_offset + z_sub_dim < i )
92  return 0; /* The element we are looking for is not here. */
93 
94  /* It is not hard to find the element */
95  z_val[(ptrdiff_t)(z_val_s * (i-global_offset-1))] = alpha;
96 
97  return 0; /* success? */
98 }
99 
100 /* Virtual function table */
102 {
104  ,&RTOp_obj_null_vtbl /* use null type for reduction target object */
105  ,"TOp_set_ele"
106  ,NULL /* use default from reduct_vtbl */
108  ,NULL
109  ,NULL
110 };
111 
112 
113 /* Class specific functions */
114 
116  , struct RTOp_RTOp* op )
117 {
118  struct RTOp_value_index_type *val_ind = NULL;
120  op->vtbl->obj_data_vtbl->obj_create(NULL,NULL,&op->obj_data);
121  val_ind = (struct RTOp_value_index_type*)op->obj_data;
122  val_ind->value = alpha;
123  val_ind->index = i;
124  return 0; /* success? */
125 }
126 
128 {
129  op->vtbl->obj_data_vtbl->obj_free(NULL,NULL,&op->obj_data);
130  op->vtbl = NULL;
131  return 0; /* success? */
132 }
133 
135  , struct RTOp_RTOp* op )
136 {
137  struct RTOp_value_index_type
138  *val_ind = (struct RTOp_value_index_type*)op->obj_data;
139  val_ind->value = alpha;
140  val_ind->index = i;
141  return 0; /* success? */
142 }
double RTOp_value_type
Definition: RTOp.h:69
ptrdiff_t values_stride
Definition: RTOp.h:338
void * RTOp_ReductTarget
Definition: RTOp.h:191
const struct RTOp_obj_type_vtbl_t RTOp_obj_value_index_vtbl
int(* obj_create)(const struct RTOp_obj_type_vtbl_t *vtbl, const void *instance_data, void **obj)
Definition: RTOp.h:941
const struct RTOp_obj_type_vtbl_t * obj_data_vtbl
Definition: RTOp.h:819
int RTOp_TOp_set_ele_destroy(struct RTOp_RTOp *op)
int RTOp_TOp_set_ele_construct(RTOp_index_type i, RTOp_value_type alpha, struct RTOp_RTOp *op)
RTOp_index_type sub_dim
Definition: RTOp.h:334
#define RTOp_ERR_INVALID_NUM_VECS
Definition: RTOp.h:266
int(* obj_free)(const struct RTOp_obj_type_vtbl_t *vtbl, const void *instance_data, void **obj)
Definition: RTOp.h:1019
const struct RTOp_RTOp_vtbl_t RTOp_TOp_set_ele_vtbl
RTOp_value_type * values
Definition: RTOp.h:336
const struct RTOp_obj_type_vtbl_t RTOp_obj_null_vtbl
int RTOp_TOp_set_ele_set_i_alpha(RTOp_index_type i, RTOp_value_type alpha, struct RTOp_RTOp *op)
void * obj_data
Definition: RTOp.h:800
const struct RTOp_RTOp_vtbl_t * vtbl
Definition: RTOp.h:802
RTOp_index_type global_offset
Definition: RTOp.h:332
static int RTOp_TOp_set_ele_apply_op(const struct RTOp_RTOp_vtbl_t *vtbl, const void *obj_data, const int num_vecs, const struct RTOp_SubVector vecs[], const int num_targ_vecs, const struct RTOp_MutableSubVector targ_vecs[], RTOp_ReductTarget targ_obj)
#define RTOp_ERR_INVALID_NUM_TARG_VECS
Definition: RTOp.h:268
Teuchos_Ordinal RTOp_index_type
Definition: RTOp.h:68