/* * Copyright (C) 1998 by Southwest Research Institute (SwRI) * * All rights reserved under U.S. Copyright Law and International Conventions. * * The development of this Software was supported by contracts NAG5-3148, * NAG5-6855, NAS8-36840, NAG5-2323, and NAG5-7043 issued on behalf of * the United States Government by its National Aeronautics and Space * Administration. Southwest Research Institute grants to the Government, * and others acting on its behalf, a paid-up nonexclusive, irrevocable, * worldwide license to reproduce, prepare derivative works, and perform * publicly and display publicly, by or on behalf of the Government. * Other than those rights granted to the United States Government, no part * of this Software may be reproduced in any form or by any means, electronic * or mechanical, including photocopying, without permission in writing from * Southwest Research Institute. All inquiries should be addressed to: * * Director of Contracts * Southwest Research Institute * P. O. Drawer 28510 * San Antonio, Texas 78228-0510 * * * Use of this Software is governed by the terms of the end user license * agreement, if any, which accompanies or is included with the Software * (the "License Agreement"). An end user will be unable to install any * Software that is accompanied by or includes a License Agreement, unless * the end user first agrees to the terms of the License Agreement. Except * as set forth in the applicable License Agreement, any further copying, * reproduction or distribution of this Software is expressly prohibited. * Installation assistance, product support and maintenance, if any, of the * Software is available from SwRI and/or the Third Party Providers, as the * case may be. * * Disclaimer of Warranty * * SOFTWARE IS WARRANTED, IF AT ALL, IN ACCORDANCE WITH THESE TERMS OF THE * LICENSE AGREEMENT. UNLESS OTHERWISE EXPLICITLY STATED, THIS SOFTWARE IS * PROVIDED "AS IS", IS EXPERIMENTAL, AND IS FOR NON-COMMERCIAL USE ONLY, * AND ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, * INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR * PURPOSE, OR NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT * SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID. * * Limitation of Liability * * SwRI SHALL NOT BE LIABLE FOR ANY DAMAGES SUFFERED AS A RESULT OF USING, * MODIFYING, CONTRIBUTING, COPYING, DISTRIBUTING, OR DOWNLOADING THIS * SOFTWARE. IN NO EVENT SHALL SwRI BE LIABLE FOR ANY INDIRECT, PUNITIVE, * SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGE (INCLUDING LOSS OF BUSINESS, * REVENUE, PROFITS, USE, DATA OR OTHER ECONOMIC ADVANTAGE) HOWEVER IT ARISES, * WHETHER FOR BREACH OF IN TORT, EVEN IF SwRI HAS BEEN PREVIOUSLY ADVISED OF * THE POSSIBILITY OF SUCH DAMAGE. YOU HAVE SOLE RESPONSIBILITY FOR ADEQUATE * PROTECTION AND BACKUP OF DATA AND/OR EQUIPMENT USED IN CONNECTION WITH THE * SOFTWARE AND WILL NOT MAKE A CLAIM AGAINST SwRI FOR LOST DATA, RE-RUN TIME, * INACCURATE OUTPUT, WORK DELAYS OR LOST PROFITS RESULTING FROM THE USE OF * THIS SOFTWARE. YOU AGREE TO HOLD SwRI HARMLESS FROM, AND YOU COVENANT NOT * TO SUE SwRI FOR, ANY CLAIMS BASED ON USING THE SOFTWARE. * * Local Laws: Export Control * * You acknowledge and agree this Software is subject to the U.S. Export * Administration Laws and Regulations. Diversion of such Software contrary * to U.S. law is prohibited. You agree that none of the Software, nor any * direct product therefrom, is being or will be acquired for, shipped, * transferred, or reexported, directly or indirectly, to proscribed or * embargoed countries or their nationals, nor be used for nuclear activities, * chemical biological weapons, or missile projects unless authorized by U.S. * Government. Proscribed countries are set forth in the U.S. Export * Administration Regulations. Countries subject to U.S embargo are: Cuba, * Iran, Iraq, Libya, North Korea, Syria, and the Sudan. This list is subject * to change without further notice from SwRI, and you must comply with the * list as it exists in fact. You certify that you are not on the U.S. * Department of Commerce's Denied Persons List or affiliated lists or on the * U.S. Department of Treasury's Specially Designated Nationals List. You agree * to comply strictly with all U.S. export laws and assume sole responsibilities * for obtaining licenses to export or reexport as may be required. * * General * * These Terms represent the entire understanding relating to the use of the * Software and prevail over any prior or contemporaneous, conflicting or * additional, communications. SwRI can revise these Terms at any time * without notice by updating this posting. * * Trademarks * * The SwRI logo is a trademark of SwRI in the United States and other countries. * */ #ident "@(#) band_bins.c 1.18 05/08/19 SwRI" #include "user_defs.h" #include "libtrec_idfs.h" /***************************************************************************** * * * IR_BAND_BINS SUBROUTINE * * * * DESCRIPTION * * This routine is called in order to determine which bin is covered by * * the value given using a binary search. Note that the value being looked * * for is assumed to lie within the array of values being searched through. * * * * INPUT VARIABLES * * reg SDDAS_FLOAT comp_val value to be searched for within the bins * * SDDAS_FLOAT *band_low pointer to lower band edges * * SDDAS_FLOAT *band_high pointer to upper band edges * * SDDAS_CHAR swp_fmt indicates if bins are created with log, * * linear or variable width spacing * * SDDAS_SHORT num_bins the number of bins to examine * * * * USAGE * * x = ir_band_bins (comp_val, band_low, band_high, swp_fmt, num_bins) * * * * NECESSARY SUBPROGRAMS * * None * * * * EXTERNAL VARIABLES * * None * * * * INTERNAL VARIABLES * * reg SDDAS_FLOAT *blow, *bhigh ptrs to the lower and upper band edges * * register SDDAS_SHORT bin the current bin index * * reg SDDAS_SHORT low_bound, variables used for the binary search on * * high_bound the band edges to find the specified value * * SDDAS_CHAR increasing_range flag indicating if scan range is increasing* * or decreasing as we progress down the bins * * * * SUBSYSTEM * * Display Level * * * * OPTIMAZATION STATUS * * Fully optimized: Note that now this routine assumes the following * * 1) the data input lies within the limits provided by the bands being * * checked * * 2) band_low is the array of all the lower band edges * * 3) band_high is the array of all the upper band edges * * 4) for each band band_high > band_low * * * * The above conditions are now placed on the calling routines * ****************************************************************************/ SDDAS_SHORT ir_band_bins (register SDDAS_FLOAT comp_val, SDDAS_FLOAT *band_low, SDDAS_FLOAT *band_high, SDDAS_CHAR swp_fmt, SDDAS_SHORT num_bins) { register SDDAS_FLOAT *blow, *bhigh; register SDDAS_SHORT bin, low_bound, high_bound; SDDAS_CHAR increasing_range; /****************************************************************/ /* Determine which bin is covered by the value given using a */ /* binary search. Note that the value being looked for is */ /* assumed to lie within the array of values being searched */ /* through - checks to omit this search if the value is outside */ /* the array range must be made external to this routine */ /****************************************************************/ bin = -1; blow = band_low; bhigh = band_high; increasing_range = (*blow < *(blow + 1)) ? 1 : 0; low_bound = 0; high_bound = num_bins - 1; /********************************************************************/ /* Non-contiguous bands need <= and >= checks. */ /********************************************************************/ if (swp_fmt == ZERO_SPACING || swp_fmt == VARIABLE_SPACING) { /********************************************************************/ /* Scan bins values are increasing (going from low to high). */ /********************************************************************/ if (increasing_range) { /********************************************************************/ /* Check the data only if the data lies within the band values. */ /********************************************************************/ while (low_bound <= high_bound) { bin = (low_bound + high_bound) >> 1; if (comp_val >= *(blow + bin)) low_bound = (comp_val <= *(bhigh + bin)) ? num_bins : bin + 1; else high_bound = bin - 1; } } /********************************************************************/ /* Scan bins values are decreasing (going from high to low). */ /********************************************************************/ else { /********************************************************************/ /* Check the data only if the data lies within the band values. */ /********************************************************************/ while (low_bound <= high_bound) { bin = (low_bound + high_bound) >> 1; if (comp_val <= *(blow + bin)) low_bound = (comp_val >= *(bhigh + bin)) ? num_bins : bin + 1; else high_bound = bin - 1; } } } else { /********************************************************************/ /* Scan bins values are increasing (going from low to high). */ /********************************************************************/ if (increasing_range) { /********************************************************************/ /* Check the data only if the data lies within the band values. */ /********************************************************************/ while (low_bound <= high_bound) { bin = (low_bound + high_bound) >> 1; if (comp_val >= *(blow + bin)) low_bound = (comp_val < *(bhigh + bin)) ? num_bins : bin + 1; else high_bound = bin - 1; } } /********************************************************************/ /* Scan bins values are decreasing (going from high to low). */ /********************************************************************/ else { /********************************************************************/ /* Check the data only if the data lies within the band values. */ /********************************************************************/ while (low_bound <= high_bound) { bin = (low_bound + high_bound) >> 1; if (comp_val <= *(blow + bin)) low_bound = (comp_val > *(bhigh + bin)) ? num_bins : bin + 1; else high_bound = bin - 1; } } } return (bin); }