MOOCHO (Single Doxygen Collection) Version of the Day
RTOp_TOp_scale_vector.c
Go to the documentation of this file.
00001 /*
00002 // @HEADER
00003 // ***********************************************************************
00004 // 
00005 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
00006 //                  Copyright (2003) Sandia Corporation
00007 // 
00008 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00009 // license for use of this work by or on behalf of the U.S. Government.
00010 // 
00011 // Redistribution and use in source and binary forms, with or without
00012 // modification, are permitted provided that the following conditions are
00013 // met:
00014 //
00015 // 1. Redistributions of source code must retain the above copyright
00016 // notice, this list of conditions and the following disclaimer.
00017 //
00018 // 2. Redistributions in binary form must reproduce the above copyright
00019 // notice, this list of conditions and the following disclaimer in the
00020 // documentation and/or other materials provided with the distribution.
00021 //
00022 // 3. Neither the name of the Corporation nor the names of the
00023 // contributors may be used to endorse or promote products derived from
00024 // this software without specific prior written permission.
00025 //
00026 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00027 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00028 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00029 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00030 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00031 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00032 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00033 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00034 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00035 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00036 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00037 //
00038 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00039 // 
00040 // ***********************************************************************
00041 // @HEADER
00042 */
00043 
00044 #include "RTOp_TOp_scale_vector.h"
00045 #include "RTOp_obj_value_vtbl.h"
00046 #include "RTOp_obj_null_vtbl.h"
00047 
00048 /* Implementation functions for RTOp_RTOp */
00049 
00050 static int RTOp_TOp_scale_vector_apply_op(
00051   const struct RTOp_RTOp_vtbl_t* vtbl, const void* obj_data
00052   , const int num_vecs, const struct RTOp_SubVector vecs[]
00053   , const int num_targ_vecs, const struct RTOp_MutableSubVector targ_vecs[]
00054   , RTOp_ReductTarget targ_obj )
00055 {
00056   RTOp_value_type        alpha = 0.0;
00057   RTOp_index_type        z_sub_dim;
00058   RTOp_value_type        *z_val;
00059   ptrdiff_t              z_val_s;
00060   register RTOp_index_type k;
00061 
00062   /* */
00063   /* Validate the input */
00064   /* */
00065 
00066   if( num_vecs != 0 || vecs != NULL )
00067     return RTOp_ERR_INVALID_NUM_VECS;
00068   if( num_targ_vecs != 1 || targ_vecs == NULL )
00069     return RTOp_ERR_INVALID_NUM_TARG_VECS;
00070   assert(obj_data);
00071 
00072   /* */
00073   /* Get pointers to data */
00074   /* */
00075 
00076   /* alpha */
00077   alpha = *((RTOp_value_type*)obj_data);
00078 
00079   /* z */
00080   z_sub_dim     = targ_vecs[0].sub_dim;
00081   z_val         = targ_vecs[0].values;
00082   z_val_s       = targ_vecs[0].values_stride;
00083 
00084   /* */
00085   /* Scale the elements */
00086   /* */
00087 
00088   for( k = 0; k < z_sub_dim; ++k, z_val += z_val_s )
00089     *z_val *= alpha;
00090 
00091   return 0; /* success? */
00092 }
00093 
00094 /* Virtual function table */
00095 const struct RTOp_RTOp_vtbl_t RTOp_TOp_scale_vector_vtbl =
00096 {
00097   &RTOp_obj_value_vtbl /* use simple scalar value type for object instance data */
00098   ,&RTOp_obj_null_vtbl /* use null type for target object */
00099   ,"TOp_scalar_vector"
00100   ,NULL /* use default from reduct_vtbl */
00101   ,RTOp_TOp_scale_vector_apply_op
00102   ,NULL
00103   ,NULL
00104 };
00105 
00106 /* Class specific functions */
00107 
00108 int RTOp_TOp_scale_vector_construct( RTOp_value_type alpha, struct RTOp_RTOp* op )
00109 {
00110   op->vtbl = &RTOp_TOp_scale_vector_vtbl;
00111   op->vtbl->obj_data_vtbl->obj_create(NULL,NULL,&op->obj_data);
00112   *((RTOp_value_type*)op->obj_data) = alpha;
00113   return 0; /* success? */
00114 }
00115 
00116 int RTOp_TOp_scale_vector_destroy( struct RTOp_RTOp* op )
00117 {
00118   op->vtbl->obj_data_vtbl->obj_free(NULL,NULL,&op->obj_data);
00119   op->vtbl = NULL;
00120   return 0; /* success? */
00121 }
00122 
00123 int RTOp_TOp_scale_vector_set_alpha( RTOp_value_type alpha, struct RTOp_RTOp* op )
00124 {
00125   *((RTOp_value_type*)op->obj_data) = alpha;
00126   return 0; /* success? */
00127 }
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines