Leap Accelerate API Reference

The following documentation presents the C++ API.

Class Hierarchy

• • Namespace icrar
    • Namespace icrar::cpu
      • Struct Constants
      • Class BeamCalibration
      • Class Calibration
      • Class CalibrationCollection
      • Class CpuLeapCalibrator
      • Class Integration
      • Class MetaData
    • Namespace icrar::cuda
      • Class ComputeDevice
      • Class ConstantBuffer
      • Class CudaLeapCalibrator
      • Template Class device_matrix
      • Template Class device_tensor3
      • Template Class device_vector
      • Class DeviceIntegration
      • Class DeviceMetaData
      • Class DirectionBuffer
      • Class HostIntegration
      • Class HostMetaData
      • Class SolutionIntervalBuffer
      • Enum JobType
      • Enum MatrixOp
    • Namespace icrar::detail
      • Template Struct _fixed
      • Struct _memory_amount
      • Struct _microseconds_amount
    • Namespace icrar::log
      • Enum Verbosity
    • Namespace icrar::profiling
      • Struct ResourceUsage
      • Class timer
      • Class UsageReporter
    • Struct ArgumentsDTO
    • Struct CLIArgumentsDTO
    • Struct ComputeOptionsDTO
    • Template Struct matrix_hash
    • Struct visibility
    • Class ArgumentsValidated
    • Class CpuComputeOptions
    • Class CudaComputeOptions
    • Class exception
    • Class file_exception
    • Class ILeapCalibrator
    • Class invalid_argument_exception
    • Class json_exception
    • Class LeapCalibratorFactory
    • Class MeasurementSet
    • Class not_implemented_exception
    • Class Range
    • Class Slice
    • Enum ComputeImplementation
    • Enum InputType
    • Enum StreamOutType
  • Class band_data
  • Class channel_info

File Hierarchy

• • Directory src
    • Directory icrar
      • Directory leap-accelerate
        • Directory algorithm
          • Directory cpu
            • File CpuComputeOptions.h
            • File CpuLeapCalibrator.h
            • File PhaseMatrixFunction.h
          • Directory cuda
            • Directory kernel
              • File ComputePhaseDeltaKernel.h
              • File CopyPhaseDeltaKernel.h
              • File EmptyKernel.h
              • File PolarizationsToPhaseAnglesKernel.h
              • File RotateVisibilitiesKernel.h
            • File CudaComputeOptions.h
            • File CudaLeapCalibrator.h
          • File ComputeOptionsDTO.h
          • File ILeapCalibrator.h
          • File LeapCalibratorFactory.h
        • Directory common
          • Directory config
            • File Arguments.h
          • File constants.h
          • File eigen_cache.h
          • File eigen_stringutils.h
          • File enumutils.h
          • File Range.h
          • File Slice.h
          • File SphericalDirection.h
          • File stream_extensions.h
          • File Tensor3X.h
        • Directory core
          • Directory log
            • File logging.h
            • File Verbosity.h
          • Directory memory
            • File ioutils.h
            • File system_memory.h
          • Directory profiling
            • File resource_usage.h
            • File timer.h
            • File UsageReporter.h
          • File compute_implementation.h
          • File git_revision.h
          • File InputType.h
          • File stream_out_type.h
          • File version.h
        • Directory cuda
          • File compute_device.h
          • File cuda_info.h
          • File device_matrix.h
          • File device_tensor.h
          • File device_vector.h
        • Directory exception
          • File exception.h
        • Directory math
          • Directory cpu
            • File eigen_extensions.h
            • File math.h
            • File matrix_invert.h
          • Directory cuda
            • File matrix.h
            • File matrix_add.h
            • File matrix_invert.h
            • File matrix_multiply.h
            • File matrix_op.h
            • File matrix_transpose.h
          • File casacore_helper.h
          • File complex_extensions.h
          • File math_conversion.h
          • File vector_extensions.h
        • Directory model
          • Directory cpu
            • Directory calibration
              • File BeamCalibration.h
              • File Calibration.h
              • File CalibrationCollection.h
            • File Integration.h
            • File MetaData.h
            • File MVuvw.h
          • Directory cuda
            • File DeviceIntegration.h
            • File DeviceMetaData.h
            • File HostIntegration.h
            • File HostMetaData.h
          • File band_data.h
          • File visibility.h
        • Directory ms
          • File MeasurementSet.h
          • File utils.h
        • Directory tests
          • Directory algorithm
            • File PhaseRotateTestCaseData.h
          • Directory helper
            • File model_helper.h
          • Directory math
            • File eigen_helper.h
          • File gtest_helper.h
          • File test_helper.h

Full API

Namespaces

• Namespace Eigen
  • Detailed Description
  • Typedefs

• Namespace icrar
  • Detailed Description
  • Namespaces
  • Classes
  • Enums
  • Functions
  • Typedefs

• Namespace icrar::constants
  • Variables

• Namespace icrar::cpu
  • Classes
  • Functions

• Namespace icrar::cuda
  • Classes
  • Enums
  • Functions

• Namespace icrar::detail
  • Classes
  • Functions

• Namespace icrar::log
  • Enums
  • Functions
  • Variables

• Namespace icrar::profiling
  • Classes
  • Functions
  • Typedefs

Classes and Structs

• Struct ArgumentsDTO
  • Struct Documentation

• Struct CLIArgumentsDTO
  • Struct Documentation

• Struct ComputeOptionsDTO
  • Struct Documentation

• Struct Constants
  • Struct Documentation

• Template Struct _fixed
  • Struct Documentation

• Struct _memory_amount
  • Struct Documentation

• Struct _microseconds_amount
  • Struct Documentation

• Template Struct matrix_hash
  • Inheritance Relationships
    • Base Type
  • Struct Documentation

• Struct ResourceUsage
  • Struct Documentation

• Struct visibility
  • Struct Documentation

• Class band_data
  • Class Documentation

• Class channel_info
  • Class Documentation

• Class ArgumentsValidated
  • Class Documentation

• Class BeamCalibration
  • Class Documentation

• Class Calibration
  • Class Documentation

• Class CalibrationCollection
  • Class Documentation

• Class CpuLeapCalibrator
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class Integration
  • Inheritance Relationships
    • Derived Type
  • Class Documentation

• Class MetaData
  • Inheritance Relationships
    • Derived Type
  • Class Documentation

• Class CpuComputeOptions
  • Class Documentation

• Class ComputeDevice
  • Class Documentation

• Class ConstantBuffer
  • Class Documentation

• Class CudaLeapCalibrator
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Template Class device_matrix
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Template Class device_tensor3
  • Class Documentation

• Template Class device_vector
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class DeviceIntegration
  • Class Documentation

• Class DeviceMetaData
  • Class Documentation

• Class DirectionBuffer
  • Class Documentation

• Class HostIntegration
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class HostMetaData
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class SolutionIntervalBuffer
  • Class Documentation

• Class CudaComputeOptions
  • Class Documentation

• Class exception
  • Inheritance Relationships
    • Base Type
    • Derived Types
  • Class Documentation

• Class file_exception
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class ILeapCalibrator
  • Inheritance Relationships
    • Base Type
    • Derived Types
  • Class Documentation

• Class invalid_argument_exception
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class json_exception
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class LeapCalibratorFactory
  • Class Documentation

• Class MeasurementSet
  • Class Documentation

• Class not_implemented_exception
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class timer
  • Class Documentation

• Class UsageReporter
  • Class Documentation

• Class Range
  • Class Documentation

• Class Slice
  • Class Documentation

Enums

• Enum ComputeImplementation
  • Enum Documentation

• Enum JobType
  • Enum Documentation

• Enum MatrixOp
  • Enum Documentation

• Enum InputType
  • Enum Documentation

• Enum Verbosity
  • Enum Documentation

• Enum StreamOutType
  • Enum Documentation

Functions

• Function assert_near_cd
  • Function Documentation

• Function assert_near_matrix3_d
  • Function Documentation

• Function assert_near_matrix_cd
  • Function Documentation

• Function assert_near_matrix_d
  • Function Documentation

• Function assert_near_matrix_i
  • Function Documentation

• Function assert_near_metadata
  • Function Documentation

• Template Function assert_near_tensor
  • Function Documentation

• Function assert_near_vector_d(const Eigen::VectorXd&, const Eigen::VectorXd&, double, const std::string&, const std::string&, const std::string&, int)
  • Function Documentation

• Function assert_near_vector_d(const std::vector<double>&, const std::vector<double>&, double, const std::string&, const std::string&, const std::string&, int)
  • Function Documentation

• Function assert_near_vector_i
  • Function Documentation

• Function GetCudaDeviceCount
  • Function Documentation

• Template Function icrar::ArrayFill
  • Function Documentation

• Template Function icrar::ArrayMax
  • Function Documentation

• Template Function icrar::AttributeEquals
  • Function Documentation

• Template Function icrar::casa_matrix_map
  • Function Documentation

• Template Function icrar::casa_vector_map
  • Function Documentation

• Function icrar::ComputeImplementationToString
  • Function Documentation

• Template Function icrar::ConvertMatrix(const Eigen::Matrix<T, R, C>&)
  • Function Documentation

• Template Function icrar::ConvertMatrix(const Eigen::Matrix<T, Eigen::Dynamic, Eigen::Dynamic>&)
  • Function Documentation

• Template Function icrar::ConvertVector
  • Function Documentation

• Function icrar::cpu::arg
  • Function Documentation

• Template Function icrar::cpu::ceil_div
  • Function Documentation

• Function icrar::cpu::near
  • Function Documentation

• Function icrar::cpu::PhaseMatrixFunction
  • Function Documentation

• Template Function icrar::cpu::pseudo_inverse
  • Function Documentation

• Template Function icrar::cpu::standard_deviation
  • Function Documentation

• Template Function icrar::cpu::SVDPseudoInverse
  • Function Documentation

• Template Function icrar::cpu::WrappedRowSelect
  • Function Documentation

• Function icrar::cuda::AvgDataToPhaseAngles
  • Function Documentation

• Function icrar::cuda::CalcDeltaPhase
  • Function Documentation

• Function icrar::cuda::Empty
  • Function Documentation

• Function icrar::cuda::GenerateDeltaPhaseColumn
  • Function Documentation

• Function icrar::cuda::pseudo_inverse(cusolverDnHandle_t, cublasHandle_t, const Eigen::Matrix<double, Eigen::Dynamic, Eigen::Dynamic>&, const JobType)
  • Function Documentation

• Function icrar::cuda::pseudo_inverse(cusolverDnHandle_t, cublasHandle_t, const device_matrix<double>&, const JobType)
  • Function Documentation

• Function icrar::cuda::RotateVisibilities
  • Function Documentation

• Function icrar::cuda::svd
  • Function Documentation

• Function icrar::cuda::ToCublasOp
  • Function Documentation

• Template Function icrar::detail::operator<<(std::basic_ostream<T>&, detail::_fixed<N, VT>)
  • Function Documentation

• Template Function icrar::detail::operator<<(std::basic_ostream<T>&, const detail::_memory_amount&)
  • Function Documentation

• Template Function icrar::detail::operator<<(std::basic_ostream<T>&, const detail::_microseconds_amount&)
  • Function Documentation

• Template Function icrar::Dot(const icrar::MVuvw&, const Eigen::Matrix<T, 3, 3>&)
  • Function Documentation

• Template Function icrar::Dot(const casacore::MVuvw&, const casacore::Matrix<T>&)
  • Function Documentation

• Template Function icrar::Equal(const boost::optional<casacore::Matrix<T>>&, const boost::optional<casacore::Matrix<T>>&)
  • Function Documentation

• Template Function icrar::Equal(const casacore::Array<T>&, const casacore::Array<T>&)
  • Function Documentation

• Template Function icrar::fixed
  • Function Documentation

• Function icrar::GetAllTimestepsMWACalibration
  • Function Documentation

• Function icrar::GetAvailableCudaPhysicalMemory
  • Function Documentation

• Function icrar::GetEachTimestepMWACalibration
  • Function Documentation

• Function icrar::GetFirstTimestepMWACalibration
  • Function Documentation

• Function icrar::GetTotalAvailableSystemVirtualMemory
  • Function Documentation

• Function icrar::GetTotalCudaPhysicalMemory
  • Function Documentation

• Function icrar::GetTotalSystemVirtualMemory
  • Function Documentation

• Function icrar::GetTotalUsedSystemVirtualMemory
  • Function Documentation

• Function icrar::git_has_local_changes
  • Function Documentation

• Function icrar::git_sha1
  • Function Documentation

• Template Function icrar::isApprox(const Tensor3X<T>&, const Tensor3X<T>&, double)
  • Function Documentation

• Template Function icrar::isApprox(const std::complex<T>&, const std::complex<T>&, T)
  • Function Documentation

• Template Function icrar::isApprox(const std::vector<T>&, const std::vector<T>&, T)
  • Function Documentation

• Function icrar::IsImmediateMode
  • Function Documentation

• Function icrar::log::Initialize
  • Function Documentation

• Function icrar::log::ParseVerbosity
  • Function Documentation

• Function icrar::log::TryParseVerbosity
  • Function Documentation

• Function icrar::memory_amount
  • Function Documentation

• Template Function icrar::ms_read_coords
  • Function Documentation

• Template Function icrar::ms_read_vis
  • Function Documentation

• Function icrar::ParseComputeImplementation
  • Function Documentation

• Function icrar::ParseDirections(const std::string&)
  • Function Documentation

• Function icrar::ParseDirections(const rapidjson::Value&)
  • Function Documentation

• Function icrar::ParseInputType
  • Function Documentation

• Function icrar::ParseSlice(const std::string&)
  • Function Documentation

• Function icrar::ParseSlice(const rapidjson::Value&)
  • Function Documentation

• Function icrar::ParseStreamOutType
  • Function Documentation

• Template Function icrar::pretty_matrix
  • Function Documentation

• Template Function icrar::pretty_row
  • Function Documentation

• Template Function icrar::ProcessCache
  • Function Documentation

• Function icrar::profiling::get_resource_usage
  • Function Documentation

• Template Function icrar::profiling::operator<<(std::basic_ostream<CharT>&, const ResourceUsage&)
  • Function Documentation

• Template Function icrar::profiling::operator<<(std::basic_ostream<CharT, Traits>&, const timer&)
  • Function Documentation

• Template Function icrar::range(IntType, IntType, IntType)
  • Function Documentation

• Template Function icrar::range(IntType, IntType)
  • Function Documentation

• Template Function icrar::range(IntType)
  • Function Documentation

• Template Function icrar::read_binary
  • Function Documentation

• Template Function icrar::read_hash
  • Function Documentation

• Template Function icrar::to_underlying_type
  • Function Documentation

• Function icrar::ToCasaDirection
  • Function Documentation

• Function icrar::ToCasaDirectionVector
  • Function Documentation

• Function icrar::ToCasaUVW
  • Function Documentation

• Function icrar::ToCasaUVWVector(const std::vector<icrar::MVuvw>&)
  • Function Documentation

• Function icrar::ToCasaUVWVector(const Eigen::MatrixX3d&)
  • Function Documentation

• Function icrar::ToDirection
  • Function Documentation

• Function icrar::ToDirectionVector
  • Function Documentation

• Template Function icrar::ToFixedMatrix
  • Function Documentation

• Template Function icrar::ToMatrix(const casacore::Matrix<T>&)
  • Function Documentation

• Function icrar::ToMatrix(const std::vector<MVuvw>&)
  • Function Documentation

• Function icrar::ToUVW
  • Function Documentation

• Function icrar::ToUVWVector(const std::vector<casacore::MVuvw>&)
  • Function Documentation

• Function icrar::ToUVWVector(const Eigen::MatrixXd&)
  • Function Documentation

• Template Function icrar::ToVector(casacore::Vector<T>)
  • Function Documentation

• Template Function icrar::ToVector(const std::vector<T>&)
  • Function Documentation

• Template Function icrar::trace_matrix
  • Function Documentation

• Template Function icrar::Transpose
  • Function Documentation

• Function icrar::TryParseComputeImplementation
  • Function Documentation

• Function icrar::TryParseInputType
  • Function Documentation

• Function icrar::TryParseStreamOutType
  • Function Documentation

• Function icrar::us_time
  • Function Documentation

• Template Function icrar::vector_map
  • Function Documentation

• Function icrar::version
  • Function Documentation

• Template Function icrar::write_binary
  • Function Documentation

• Template Function icrar::write_hash
  • Function Documentation

• Function mat_mul(cublasHandle_t, MatrixOp, MatrixOp, const size_t, const size_t, const size_t, const float *, const float *, float *)
  • Function Documentation

• Function mat_mul(cublasHandle_t, MatrixOp, MatrixOp, const size_t, const size_t, const size_t, const int *, const int *, int *)
  • Function Documentation

• Function mat_mul(cublasLtHandle_t, MatrixOp, MatrixOp, const size_t, const size_t, const size_t, const double *, const double *, double *)
  • Function Documentation

• Function mat_mul(cublasLtHandle_t, MatrixOp, MatrixOp, const size_t, const size_t, const size_t, const float *, const float *, float *)
  • Function Documentation

• Function mat_mul(cublasLtHandle_t, MatrixOp, MatrixOp, const size_t, const size_t, const size_t, const int *, const int *, int *)
  • Function Documentation

• Function mat_mul_add(cublasHandle_t, const size_t, const size_t, const size_t, const double *, const double *, double *)
  • Function Documentation

• Function mat_mul_add(cublasHandle_t, const size_t, const size_t, const size_t, const float *, const float *, float *)
  • Function Documentation

• Function mat_mul_add(cublasHandle_t, const size_t, const size_t, const size_t, const int *, const int *, int *)
  • Function Documentation

• Function mat_mul_add(cublasLtHandle_t, const size_t, const size_t, const size_t, const double *, const double *, const double *, double *)
  • Function Documentation

• Function mat_mul_add(cublasLtHandle_t, const size_t, const size_t, const size_t, const float *, const float *, const float *, float *)
  • Function Documentation

• Function mat_mul_add(cublasLtHandle_t, const size_t, const size_t, const size_t, const int *, const int *, const int *, int *)
  • Function Documentation

• Template Function multiply(cublasHandle_t, const device_matrix<T>&, const device_vector<T>&, device_vector<T>&, MatrixOp, MatrixOp)
  • Function Documentation

• Template Function multiply(cublasHandle_t, const device_matrix<T>&, const device_matrix<T>&, device_matrix<T>&, MatrixOp, MatrixOp)
  • Function Documentation

• Template Function multiply(cublasLtHandle_t, const device_matrix<T>&, const device_vector<T>&, device_vector<T>&, MatrixOp, MatrixOp)
  • Function Documentation

• Template Function multiply(cublasLtHandle_t, const device_matrix<T>&, const device_matrix<T>&, device_matrix<T>&, MatrixOp, MatrixOp)
  • Function Documentation

• Template Function multiply_add(cublasLtHandle_t, const device_matrix<T>&, const device_vector<T>&, const device_vector<T>&, device_vector<T>&)
  • Function Documentation

• Template Function multiply_add(cublasHandle_t, const device_matrix<T>&, const device_matrix<T>&, device_matrix<T>&)
  • Function Documentation

• Template Function multiply_add(cublasHandle_t, const device_matrix<T>&, const device_vector<T>&, device_vector<T>&)
  • Function Documentation

• Template Function multiply_add(cublasLtHandle_t, const device_matrix<T>&, const device_matrix<T>&, const device_matrix<T>&, device_matrix<T>&)
  • Function Documentation

• Template Function operator<<(std::ostream&, const std::set<T>&)
  • Function Documentation

• Template Function operator<<(std::ostream&, const std::map<T, S>&)
  • Function Documentation

• Template Function operator<<(std::ostream&, const std::vector<T>&)
  • Function Documentation

• Function printCudaVersion
  • Function Documentation

Variables

• Variable icrar::constants::speed_of_light
  • Variable Documentation

• Variable icrar::log::DEFAULT_VERBOSITY
  • Variable Documentation

• Variable icrar::log::logging_level
  • Variable Documentation

• Variable pretty_width
  • Variable Documentation

Typedefs

• Typedef cublasLtHandle_t
  • Typedef Documentation

• Typedef Eigen::MatrixXb
  • Typedef Documentation

• Typedef Eigen::VectorXb
  • Typedef Documentation

• Typedef icrar::MVuvw
  • Typedef Documentation

• Typedef icrar::profiling::usec_t
  • Typedef Documentation

• Typedef icrar::SphericalDirection
  • Typedef Documentation

• Typedef icrar::Tensor3X
  • Typedef Documentation