MOOCHO (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
RTOp_TOp_scale_vector.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_scale_vector.h"
45 #include "RTOp_obj_value_vtbl.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  RTOp_value_type alpha = 0.0;
57  RTOp_index_type z_sub_dim;
58  RTOp_value_type *z_val;
59  ptrdiff_t z_val_s;
60  register RTOp_index_type k;
61 
62  /* */
63  /* Validate the input */
64  /* */
65 
66  if( num_vecs != 0 || vecs != NULL )
68  if( num_targ_vecs != 1 || targ_vecs == NULL )
70  assert(obj_data);
71 
72  /* */
73  /* Get pointers to data */
74  /* */
75 
76  /* alpha */
77  alpha = *((RTOp_value_type*)obj_data);
78 
79  /* z */
80  z_sub_dim = targ_vecs[0].sub_dim;
81  z_val = targ_vecs[0].values;
82  z_val_s = targ_vecs[0].values_stride;
83 
84  /* */
85  /* Scale the elements */
86  /* */
87 
88  for( k = 0; k < z_sub_dim; ++k, z_val += z_val_s )
89  *z_val *= alpha;
90 
91  return 0; /* success? */
92 }
93 
94 /* Virtual function table */
96 {
97  &RTOp_obj_value_vtbl /* use simple scalar value type for object instance data */
98  ,&RTOp_obj_null_vtbl /* use null type for target object */
99  ,"TOp_scalar_vector"
100  ,NULL /* use default from reduct_vtbl */
102  ,NULL
103  ,NULL
104 };
105 
106 /* Class specific functions */
107 
109 {
111  op->vtbl->obj_data_vtbl->obj_create(NULL,NULL,&op->obj_data);
112  *((RTOp_value_type*)op->obj_data) = alpha;
113  return 0; /* success? */
114 }
115 
117 {
118  op->vtbl->obj_data_vtbl->obj_free(NULL,NULL,&op->obj_data);
119  op->vtbl = NULL;
120  return 0; /* success? */
121 }
122 
124 {
125  *((RTOp_value_type*)op->obj_data) = alpha;
126  return 0; /* success? */
127 }
static int RTOp_TOp_scale_vector_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)
double RTOp_value_type
Definition: RTOp.h:69
ptrdiff_t values_stride
Definition: RTOp.h:338
void * RTOp_ReductTarget
Definition: RTOp.h:191
int RTOp_TOp_scale_vector_set_alpha(RTOp_value_type alpha, struct RTOp_RTOp *op)
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_scale_vector_destroy(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
RTOp_value_type * values
Definition: RTOp.h:336
const struct RTOp_obj_type_vtbl_t RTOp_obj_null_vtbl
void * obj_data
Definition: RTOp.h:800
const struct RTOp_RTOp_vtbl_t * vtbl
Definition: RTOp.h:802
const struct RTOp_RTOp_vtbl_t RTOp_TOp_scale_vector_vtbl
int RTOp_TOp_scale_vector_construct(RTOp_value_type alpha, struct RTOp_RTOp *op)
#define RTOp_ERR_INVALID_NUM_TARG_VECS
Definition: RTOp.h:268
const struct RTOp_obj_type_vtbl_t RTOp_obj_value_vtbl
Teuchos_Ordinal RTOp_index_type
Definition: RTOp.h:68