time-arrival-definitions.h

Go to the documentation of this file.

/* WOSS - World Ocean Simulation System -
 * 
 * Copyright (C) 2009 2025 Federico Guerra
 * and regents of the SIGNET lab, University of Padova
 *
 * Author: Federico Guerra - WOSS@guerra-tlc.com
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */ 
 
#ifndef TIME_ARRIVAL_DEFINITIONS_H
#define TIME_ARRIVAL_DEFINITIONS_H
 
 
#include <cassert>
#include <climits>
#include <map>
#include <memory>
#include "pressure-definitions.h"
#include "custom-precision-double.h"
 
 
namespace woss {
 
  using TimeArrMap = std::map < PDouble , std::complex<double> >; 
  using TimeArrIt = TimeArrMap::iterator;
  using TimeArrCIt = TimeArrMap::const_iterator;
  using TimeArrRIt = TimeArrMap::reverse_iterator;
  using TimeArrCRIt = TimeArrMap::const_reverse_iterator;
 
  static constexpr inline double TIMEARR_CUSTOM_DELAY_PRECISION = (1.0e-7);
  static constexpr inline int TIMEARR_PRESSURE_CONVERSION_DELAY = (-INT_MAX);
 
  class TimeArr {
 
    public:
 
    TimeArr( long double custom_delay_prec = TIMEARR_CUSTOM_DELAY_PRECISION );
 
    TimeArr( TimeArrMap& map, long double custom_delay_prec = TIMEARR_CUSTOM_DELAY_PRECISION );
 
    explicit TimeArr( const Pressure& pressure, double delay = TIMEARR_PRESSURE_CONVERSION_DELAY, long double custom_delay_prec = TIMEARR_CUSTOM_DELAY_PRECISION );
 
    TimeArr( const TimeArr& copy ) = default;
 
    TimeArr( TimeArr&& tmp ) = default;
 
    virtual ~TimeArr() = default;
 
    virtual operator std::complex<double>() const;
    
    virtual std::unique_ptr<TimeArr> create( long double custom_delay_prec = TIMEARR_CUSTOM_DELAY_PRECISION ) const { return std::make_unique<TimeArr>(custom_delay_prec); }
 
    virtual std::unique_ptr<TimeArr> create( TimeArrMap& map, long double custom_delay_prec = TIMEARR_CUSTOM_DELAY_PRECISION ) const {
      return std::make_unique<TimeArr>( map, custom_delay_prec); }
 
    virtual std::unique_ptr<TimeArr> create( const Pressure& pressure, double delay = TIMEARR_PRESSURE_CONVERSION_DELAY, long double custom_delay_prec = TIMEARR_CUSTOM_DELAY_PRECISION ) const {
      return std::make_unique<TimeArr>(pressure, delay, custom_delay_prec ); } 
    
    virtual std::unique_ptr<TimeArr> clone() const { return std::make_unique<TimeArr>(*this); }
  
    virtual std::unique_ptr<TimeArr[]> createArray( unsigned int array_size ) const { return std::make_unique<TimeArr[]>(array_size); }
    
    static TimeArrMap& createNotValid();
 
    static TimeArrMap& createImpulse();
 
    TimeArr& insertValue( double delay, const Pressure& pressure );
 
    void sumValue( double delay, const Pressure& pressure );
 
    TimeArrCIt findValue( double delay ) const { return( time_arr_map.find(delay) ); }
 
    TimeArr& eraseValue( double delay ) { time_arr_map.erase(delay); return *this; }
 
    virtual std::unique_ptr<TimeArr> coherentSumSample( double time_delay ) const;
 
    virtual std::unique_ptr<TimeArr> incoherentSumSample( double time_delay ) const;
 
    virtual std::unique_ptr<TimeArr> crop( double time_start, double time_end ) const;
 
    virtual bool checkPressureAttenuation( double distance, double frequency );
 
    TimeArrCIt begin() const { return time_arr_map.begin(); }
    
    TimeArrCIt end() const { return time_arr_map.end(); }
    
    TimeArrCRIt rbegin() const { return time_arr_map.rbegin(); }
    
    TimeArrCRIt rend() const { return time_arr_map.rend(); }
 
    TimeArrCIt at( const int i ) const ;
 
    TimeArrCIt lowerBoundTxLoss( double threshold_db ) const;
 
    int size() const { return time_arr_map.size(); }
 
    bool empty() const { return time_arr_map.empty(); } 
 
    void clear() { time_arr_map.clear(); }
 
    TimeArr& setDelayPrecision( long double precision );
 
    static void setDebug( bool flag ) { debug = flag; }
 
    double getMaxDelayValue() const { return( time_arr_map.rbegin()->first ); }
 
    double getMinDelayValue() const { return( time_arr_map.begin()->first ); }
 
    long double getDelayPrecision() const { return delay_precision; }
 
    virtual bool isValid() const; 
 
    virtual bool isConvertedFromPressure() const { return( time_arr_map.size() == 1 && ( time_arr_map.begin()->first == PDouble(TIMEARR_PRESSURE_CONVERSION_DELAY) ) ); }
 
    TimeArr& operator=( const TimeArr& copy ) = default;
 
    TimeArr& operator=( TimeArr&& tmp ) = default;
 
    friend bool operator==( const TimeArr& left, const TimeArr& right );
 
    friend bool operator!=( const TimeArr& left, const TimeArr& right );
 
    friend const TimeArr operator+( const TimeArr& left, const TimeArr& right );
 
    friend const TimeArr operator-( const TimeArr& left, const TimeArr& right );
 
    friend const TimeArr operator+( const TimeArr& left, const double right );
 
    friend const TimeArr operator-( const TimeArr& left, const double right );  
 
    friend const TimeArr operator/( const TimeArr& left, const double right );
 
    friend const TimeArr operator*( const TimeArr& left, const double right );
 
    friend const TimeArr operator+( const double left, const TimeArr& right );
 
    friend const TimeArr operator-( const double left, const TimeArr& right );  
 
    friend const TimeArr operator/( const double left, const TimeArr& right );
 
    friend const TimeArr operator*( const double left, const TimeArr& right );  
 
    friend TimeArr& operator+=( TimeArr& left, const TimeArr& right );
 
    friend TimeArr& operator-=( TimeArr& left, const TimeArr& right );
 
    friend TimeArr& operator+=( TimeArr& left, double right );
 
    friend TimeArr& operator-=( TimeArr& left, double right );
 
    friend TimeArr& operator/=( TimeArr& left, double right );
 
    friend TimeArr& operator*=( TimeArr& left, double right );
 
    friend std::ostream& operator<<( std::ostream& os, const TimeArr& instance );
 
    protected:
 
    static bool debug;
 
    long double delay_precision;
 
    TimeArrMap time_arr_map;
 
  };
 
  //non-inline operator declarations
  const TimeArr operator+( const TimeArr& left, const TimeArr& right ); 
 
  const TimeArr operator-( const TimeArr& left, const TimeArr& right ); 
 
  const TimeArr operator+( const TimeArr& left, const double right ); 
 
  const TimeArr operator-( const TimeArr& left, const double right ); 
 
  const TimeArr operator/( const TimeArr& left, const double right ); 
 
  const TimeArr operator*( const TimeArr& left, const double right ); 
 
  const TimeArr operator+( const double left, const TimeArr& right ); 
 
  const TimeArr operator-( const double left, const TimeArr& right );
 
  const TimeArr operator/( const double left, const TimeArr& right ); 
 
  const TimeArr operator*( const double left, const TimeArr& right ); 
 
  TimeArr& operator+=( TimeArr& left, const TimeArr& right ); 
 
  TimeArr& operator-=( TimeArr& left, const TimeArr& right ); 
 
  TimeArr& operator+=( TimeArr& left, double right );
 
  TimeArr& operator-=( TimeArr& left, double right ); 
 
  TimeArr& operator/=( TimeArr& left, double right );
 
  TimeArr& operator*=( TimeArr& left, double right );
 
  //inline functions
  inline TimeArrMap& TimeArr::createNotValid() {
    static TimeArrMap time_arr_map;
    time_arr_map.clear();
    time_arr_map[0.0] = Pressure::createNotValid();
    return time_arr_map;
  }
 
  inline TimeArrMap& TimeArr::createImpulse() {
    static TimeArrMap time_arr_map;
    time_arr_map.clear();
    time_arr_map[0.0] = std::complex<double> (1.0 , 0.0);
    return time_arr_map;
  }
 
  inline TimeArr& TimeArr::insertValue( double delay, const Pressure& pressure ) { 
    assert( pressure.isValid() ); 
    assert( delay >= 0.0 );
    
    time_arr_map.emplace( std::make_pair( delay, pressure ) ); 
    
    return *this;
  }
 
  inline void TimeArr::sumValue( double delay, const Pressure& pressure ) {
    assert( pressure.isValid() ); 
    assert( delay >= 0.0 );
    
    TimeArrIt it = time_arr_map.find( delay );
    if ( it == time_arr_map.end() ) 
      time_arr_map.emplace( std::make_pair( delay, pressure ) );
    else 
      it->second += std::complex<double>( pressure ); 
  }
 
  inline std::ostream& operator<<( std::ostream& os, const TimeArr& instance ) {
    os << "size = " << instance.time_arr_map.size() << "; min time_arr = " << instance.time_arr_map.begin()->first 
                    << "; pressure db = " << Pressure::getTxLossDb(instance.begin()->second)  
                    << "; max time_arr = " << instance.time_arr_map.rbegin()->first 
                    << "; pressure db = " << Pressure::getTxLossDb(instance.time_arr_map.rbegin()->second);
    return os;
  }
 
  inline bool operator==( const TimeArr& left, const TimeArr& right ) { 
    if ( &left == &right ) 
      return true; 
    return( left.time_arr_map == right.time_arr_map );
  }
 
  inline bool operator!=( const TimeArr& left, const TimeArr& right ) { 
    if ( &left == &right ) 
      return false; 
    return( left.time_arr_map != right.time_arr_map );
  }
 
}
 
#endif /* TIME_ARRIVAL_DEFINITIONS_H */