## GogRegCurve

GogRegCurve

## Synopsis

                        GogRegCurve;
                        GogRegCurveClass;
    enum                GogRegCurveDrawingBounds;
    double              gog_reg_curve_get_R2                (GogRegCurve *reg_curve);
    void                gog_reg_curve_get_bounds            (GogRegCurve *reg_curve,
                                                             double *xmin,
                                                             double *xmax);
    gchar const *       gog_reg_curve_get_equation          (GogRegCurve *reg_curve);

## Object Hierarchy

      GObject
       +----GogObject
             +----GogStyledObject
                   +----GogTrendLine
                         +----GogRegCurve

## Implemented Interfaces

GogRegCurve implements GOStyledObject and GogDataset.

## Properties

      "drawing-bounds"           gchar*                : Read / Write
      "skip-invalid"             gboolean              : Read / Write

## Description

## Details

### GogRegCurve

    typedef struct _GogRegCurve GogRegCurve;

### GogRegCurveClass

    typedef struct {
    	GogTrendLineClass base;

    	double 		(*get_value_at) (GogRegCurve *reg_curve, double x);
    	char const * 	(*get_equation) (GogRegCurve *reg_curve);
    	void 		(*populate_editor) (GogRegCurve *reg_curve, gpointer table);
    } GogRegCurveClass;

GogTrendLineClass `base`; |
`get_value_at` () | returns the calculated value.
`get_equation` () | gets the regresion equation as a string.
`populate_editor` () | populates the editor.

### enum GogRegCurveDrawingBounds

    typedef enum {
    	GOG_REG_CURVE_DRAWING_BOUNDS_NONE,
    	GOG_REG_CURVE_DRAWING_BOUNDS_ABSOLUTE,
    	GOG_REG_CURVE_DRAWING_BOUNDS_RELATIVE
    } GogRegCurveDrawingBounds;

`GOG_REG_CURVE_DRAWING_BOUNDS_NONE` | no limits.
`GOG_REG_CURVE_DRAWING_BOUNDS_ABSOLUTE` | absolute limits.
`GOG_REG_CURVE_DRAWING_BOUNDS_RELATIVE` | limits relative to the data range.

### gog_reg_curve_get_R2 ()

    double              gog_reg_curve_get_R2                (GogRegCurve *reg_curve);

### gog_reg_curve_get_bounds ()

    void                gog_reg_curve_get_bounds            (GogRegCurve *reg_curve,
                                                             double *xmin,
                                                             double *xmax);

### gog_reg_curve_get_equation ()

    gchar const *       gog_reg_curve_get_equation          (GogRegCurve *reg_curve);

## Property Details

### The `"drawing-bounds"` property

      "drawing-bounds"           gchar*                : Read / Write

How the regression line should be limited, acceptable values are "none", "absolute", and "relative".

Default value: "none"

### The `"skip-invalid"` property

      "skip-invalid"             gboolean              : Read / Write

Skip invalid data.

Default value: FALSE