• Home
• User's guide
• Reference
• apc+
• HoroGraphic
• API Doc

Astropatterns API reference

• Ranges
• Patterns
• The main loop
• Other Settings
• Auxiliary functions for custom Patterns
• Logging, tracing and error handling
• Houses and mundane positions

Ranges

ap_set_range

int ap_set_range( int range_type, 
                  double jd_start, 
                  double jd_end, 
                  char *opt_arg);

ListRanges

When setting a Range using the general API function ap_set_range with Range type AP_LIST_RANGE, the Range uses the data that have formerly been added to the ListRange using the functions ap_add_to_list_range or ap_set_list_range_from_file.

ap_set_list_range_from_file

int ap_set_list_range_from_file( char* filename );

ap_add_date_to_list_range

int ap_add_date_to_list_range( double jd_et, char* label );

ap_add_horo_to_list_range

int ap_add_horo_to_list_range( t_horo *h, char* label );

ap_clear_list_range

int ap_clear_list_range( );

ap_get_label

char* ap_get_label( t_horo* h );

Patterns

ap_set_pattern

int ap_set_pattern( int pattern, 
                    int pattern_type, 
                    size_t max_size, 
                    char* optarg );

There are two Pattern types, the standard Pattern (pattern_type = 0) and the Boolean Pattern (pattern_type = 1). Standard Patterns perform a sorted insert into the hitlist, with the Pattern's score as sort criteria. With the Boolean Pattern type, only those horoscopes having a positive score will be inserted into the result list. This makes a difference: If the Range produces sufficiently many horoscopes, the hit list of a standard Pattern will always be filled up to the max size: Even horoscopes with score 0 will be inserted into the result list. On the other hand, the hit list of a Boolean Pattern can be smaller than the maximum size and even can be empty.

The return value is an integer called the Pattern handle. It is used for building combined Patterns, see below.

ap_set_and_pattern

int ap_set_and_pattern( int pattern_handles[], size_t num_patterns);

The return value is the Pattern handle of the new Pattern.

ap_set_or_pattern

int ap_set_or_pattern( int pattern_handles[], size_t num_patterns );

The return value is the Pattern handle of the new Pattern.

ap_set_negated_pattern

int ap_set_negated_pattern( int pattern_handle );

The return value is the Pattern handle of the negated Pattern.

ap_set_combined_pattern

int ap_set_combined_pattern( int combination_type, 
                             int pattern_type, 
                             size_t max_size, 
                             ... );

This function is useful if you have a predefined and therefore fixed number of Patterns that you want to combine.

The return value is the Pattern handle of the new Pattern.

ap_set_weighted_sum_pattern

int ap_set_weighted_sum_pattern( size_t max_size, 
                                 size_t num_patterns, 
                                 int pattern_handles[], 
                                 double weights[] );

ap_set_free_pattern

int ap_set_free_pattern( int type,size_t max_size, 
                         double (*scoreFunction)(t_horo*) );

The main loop

ap_start_loop

int ap_start_loop( );

ap_get_next

int ap_get_next( t_horo *h );

If a Pattern has been set, the Range rule is used to produce the next horoscope. If there is a Pattern, this function simply retrieves the next horoscope from the hit list that has already been computed formerly in the ap_start_loop() call.

ap_get_score

double ap_get_score( t_horo *h );

ap_get_score_for_pattern

double ap_get_score_for_pattern( t_horo *h, int pattern_handle );

Other Settings

ap_set_place

int ap_set_place( double lon, double lat);

ap_set_reference_horoscope

int ap_set_reference_horoscope( double jd_et, double lon, double lat );

ap_get_reference_horoscope

t_horo* ap_get_reference_horoscope( );

ap_reset_reference_horoscope

int ap_reset_reference_horoscope( );

ap_set_sweph_opt

void ap_set_sweph_opt( int options );

ap_clear_planets

void ap_clear_planets( );

ap_set_planets_default

void ap_set_planets_default( );

ap_add_planet

void ap_add_planet( t_planet* planet );

typedef struct {
    int se_ipl;  // Planet number in Swiss Ephemeris     
    double essential_strength;
    double orb_base;     // Used for orb determination
    char short_name[3];  // Its two-letter acronym
    char* name;          
  } t_planet;

Returns the number of the planet in the list, starting with 0 for the first planet.

ap_add_planetA

int ap_add_planetA( int se_ipl, 
                    double essential_strength, 
                    double orb_base,
                    char* short_name, 
                    char* name );

ap_set_planets

void ap_set_planets( t_planet* planets, 
                     size_t size );

ap_clear_aspects

void ap_clear_aspects( );

ap_set_aspects_default

void ap_set_aspects_default( );

ap_add_aspect

void ap_add_aspect( t_aspect* aspect );

typedef struct {
    double angle;
    double orb;
    char short_name[4];
    char* name;
    } t_aspect;

ap_add_aspectA

void ap_add_aspectA( double angle, 
                     double orb, 
                     char *short_name, 
                     char* name );

ap_set_aspects

void ap_set_aspects( t_aspect* aspects, size_t size );

ap_set_aspect_parameters

void ap_set_aspect_parameters( char* par );

Auxiliary functions for custom Patterns

ap_get_planets

void ap_get_planets(t_horo *h, double *longitude);

ap_get_planet

void ap_get_planet(int i, double jd_et, double *longitude);

ap_get_houses

void ap_get_houses(t_horo *h, double *cusps);

ap_get_solar

void ap_get_solar(double jd_et, t_horo *radix, t_horo *solar, double* planets, double * cusps );

ap_get_lunar

void ap_get_lunar( double jd_et, t_horo *radix, t_horo *lunar, double* planets, double * houses );

Logging, tracing and error handling

ap_set_verbose_mode

void ap_set_verbose_mode( int iVerbose_mode = 1);

ap_get_verbose_mode

int* ap_get_verbose_mode( );

ap_clear_log

void ap_clear_log( );

ap_log_add

void ap_log_add( char* s);

ap_dump

char* ap_dump( char* objid );

ap_get_pattern_details

int ap_get_pattern_details( int pattern_handle, void **data );

ap_get_log

char* ap_get_log( );

ap_get_last_error

char* ap_get_last_error( );

ap_clear_error

void ap_clear_error();

Houses and mundane positions

ap_set_house_system

void ap_set_house_system( int house_system );

ap_set_mundane_positions

void ap_set_mundane_positions( t_double_pair* data, size_t size );

ap_set_house_strengths

void ap_set_house_strengths( double* strength );

ap_get_mundane_strength

double ap_get_mundane_strength( double m );