1 /* 2 * Copyright (c) 2019, The University of Oxford 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions are met: 7 * 1. Redistributions of source code must retain the above copyright notice, 8 * this list of conditions and the following disclaimer. 9 * 2. Redistributions in binary form must reproduce the above copyright notice, 10 * this list of conditions and the following disclaimer in the documentation 11 * and/or other materials provided with the distribution. 12 * 3. Neither the name of the University of Oxford nor the names of its 13 * contributors may be used to endorse or promote products derived from this 14 * software without specific prior written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 26 * POSSIBILITY OF SUCH DAMAGE. 27 */ 28 29 #ifndef OSKAR_SPHERICAL_HARMONIC_H_ 30 #define OSKAR_SPHERICAL_HARMONIC_H_ 31 32 /** 33 * @file oskar_spherical_harmonic.h 34 */ 35 36 #include <oskar_global.h> 37 #include <mem/oskar_mem.h> 38 39 struct oskar_SphericalHarmonic; 40 #ifndef OSKAR_SPHERICAL_HARMONIC_TYPEDEF_ 41 #define OSKAR_SPHERICAL_HARMONIC_TYPEDEF_ 42 typedef struct oskar_SphericalHarmonic oskar_SphericalHarmonic; 43 #endif 44 45 #ifdef __cplusplus 46 extern "C" { 47 #endif 48 49 OSKAR_EXPORT 50 const oskar_Mem* oskar_spherical_harmonic_coeff_const( 51 const oskar_SphericalHarmonic* h); 52 53 OSKAR_EXPORT 54 void oskar_spherical_harmonic_copy(oskar_SphericalHarmonic* dst, 55 const oskar_SphericalHarmonic* src, int* status); 56 57 OSKAR_EXPORT 58 oskar_SphericalHarmonic* oskar_spherical_harmonic_create(int type, 59 int location, int l_max, int* status); 60 61 OSKAR_EXPORT 62 void oskar_spherical_harmonic_free(oskar_SphericalHarmonic* h); 63 64 OSKAR_EXPORT 65 int oskar_spherical_harmonic_l_max(const oskar_SphericalHarmonic* h); 66 67 OSKAR_EXPORT 68 void oskar_spherical_harmonic_set_coeff(oskar_SphericalHarmonic* h, 69 int l_max, const oskar_Mem* coeff, int* status); 70 71 #ifdef __cplusplus 72 } 73 #endif 74 75 #include "math/oskar_spherical_harmonic_sum.h" 76 77 #endif /* include guard */ 78