Star placement

Use this layer when you do not want a whole chart and only need "which palace does Lucun land in?" or "how are the adjective stars distributed on this chart?".

Every index is a palace index: 0 is the Yin palace, 11 the Chou palace.

StarBirth

The entry points that take birth data all share this one parameter struct.

type StarBirth struct {
    SolarDate  string
    TimeIndex  uint8
    Gender     string
    FixLeap    bool
    Language   string
    Config     *Config
    FromStem   string
    FromBranch string
}

birth := iztro.StarBirth{
    SolarDate: "2000-8-16",
    TimeIndex: 2,
    Gender:    iztro.GenderFemale,
    FixLeap:   true,
    Language:  "en-US",
}

GetStartIndex

Purpose Find the starting palaces of Ziwei and Tianfu.

Zi Wei meaning Ziwei is the anchor of the whole chart, located from the five elements class and the lunar day by the Ziwei placement rule; the other thirteen major stars then spread out from Ziwei and Tianfu. Tianfu's position mirrors Ziwei's.

Signature

func GetStartIndex(birth StarBirth) (StartIndex, error)

Return value StartIndex{ ZiweiIndex, TianfuIndex int }.

Example

s, _ := iztro.GetStartIndex(birth)
fmt.Printf("%+v\n", s)

Output

{ZiweiIndex:4 TianfuIndex:8}

Landing indices per group

The following six entry points share a shape: they take a StarBirth and return a struct whose fields are all palace indices.

Example

l, _ := iztro.GetLuYangTuoMaIndex(birth)
c, _ := iztro.GetChangQuIndex(birth)
lx, _ := iztro.GetLuanXiIndex(birth)

fmt.Printf("%+v\n%+v %+v\n", l, c, lx)

Output

{LuIndex:6 YangIndex:7 TuoIndex:5 MaIndex:0}
{ChangIndex:6 QuIndex:4} {HongluanIndex:9 TianxiIndex:3}

Qingyang sits one palace ahead of Lucun and Tuoluo one behind — the direct expression of the mnemonic "Qingyang before Lucun, Tuoluo after".

GetDailyStarIndex / GetMonthlyStarIndex / GetYearlyStarIndex

Purpose Get the landing palaces of the adjective stars placed by day, month and year.

Zi Wei meaning Adjective stars are grouped by how they are placed: day-based stars count forward from a minor star's position, starting at day one, to the birth day; month-based stars are located from the lunar month; year-based stars are the largest group and start from the year stem or year branch.

Return value

Example

d, _ := iztro.GetDailyStarIndex(birth)
m, _ := iztro.GetMonthlyStarIndex(birth)

fmt.Printf("%+v\n%+v\n", d, m)

Output

{SantaiIndex:0 BazuoIndex:10 EnguangIndex:9 TianguiIndex:7}
{YuejieIndex:0 TianyaoIndex:5 TianxingIndex:1 YinshaIndex:0 TianyueIndex:9 TianwuIndex:0}

Edge cases and pitfalls

GetMajorStar / GetMinorStar / GetAdjectiveStar

Purpose Get the complete distribution of major, minor and adjective stars across the twelve palaces.

Signature

func GetMajorStar(birth StarBirth) ([][]Star, error)
func GetMinorStar(birth StarBirth) ([][]Star, error)
func GetAdjectiveStar(birth StarBirth) ([][]Star, error)

Return value A slice of twelve, indexed by palace index. Each item is that palace's slice of Stars, possibly empty.

Example

major, _ := iztro.GetMajorStar(birth)

for i := 0; i < 5; i++ {
    names := []string{}
    for _, s := range major[i] {
        names = append(names, s.Name)
    }
    fmt.Println(i, names)
}

Output

0 [general minister]
1 [sun sage]
2 [marshal]
3 [advisor]
4 [emperor]

Edge cases and pitfalls

GetChangsheng12 / GetBoShi12 / GetYearly12

Purpose Get how the four groups of twelve gods are arranged across the twelve palaces.

Zi Wei meaning Each group is twelve marks filling the twelve palaces, exactly one per palace: the Changsheng gods start from the five elements class with direction from gender and year-branch polarity; the Boshi gods start from Lucun with the same direction rule; the Sui-qian gods run forward from the year branch, and the Jiang-qian gods start from the trine group of the year branch.

Signature

func GetChangsheng12(birth StarBirth) ([]string, error)
func GetBoShi12(birth StarBirth) ([]string, error)
func GetYearly12(birth StarBirth) (Yearly12, error)

Return value A slice of twelve keys, indexed by palace index. GetYearly12 returns Yearly12{ Suiqian12, Jiangqian12 []string }.

Example

cs, _ := iztro.GetChangsheng12(birth)
bs, _ := iztro.GetBoShi12(birth)
y, _ := iztro.GetYearly12(birth)

fmt.Println(cs[:4])
fmt.Println(bs[:4])
fmt.Println(y.Suiqian12[:4])
fmt.Println(y.Jiangqian12[:4])

Output

[jue mu si bing]
[faylian zhoushu jiangjun xiaohao]
[diaoke bingfu suijian huiqi]
[suiyi xiishen huagai jiesha]

These are keys rather than translated names; use Translate(key, language) to display them.

GetChangsheng12StartIndex / GetJiangqian12StartIndex

Purpose Get just the starting palace of two of the god groups, without laying out the whole cycle.

Zi Wei meaning The Changsheng starting point is set by the five elements class: water 2nd starts at Shen, wood 3rd at Hai, metal 4th at Si, earth 5th at Shen, fire 6th at Yin. The Jiangxing starting point is set by the trine group of the year branch: yin/woo/xu years at Woo, shen/zi/chen years at Zi, si/you/chou years at You, hai/mao/wei years at Mao.

Signature

func GetChangsheng12StartIndex(fiveElementsClass string) (int, error)
func GetJiangqian12StartIndex(branchKey string) (int, error)

Return value int, 0–11. Neither function needs birth data.

Example

a, _ := iztro.GetChangsheng12StartIndex(iztro.ClassWater2nd)
b, _ := iztro.GetChangsheng12StartIndex(iztro.ClassFire6th)
c, _ := iztro.GetJiangqian12StartIndex(iztro.BranchZi)
d, _ := iztro.GetJiangqian12StartIndex(iztro.BranchWu)

fmt.Println(a, b, c, d)

Output

6 0 10 4

Water 2nd puts Changsheng in Shen (index 6), fire 6th in Yin (index 0).

GetHoroscopeStar

Purpose Get the scope-star distribution of a horoscope layer.

Zi Wei meaning Scope stars are the ten stars a horoscope produces: Tiankui, Tianyue, Wenchang, Wenqu, Lucun, Qingyang, Tuoluo, Tianma, Hongluan and Tianxi. Where they land is fixed by that layer's stem and branch, and their names change with the layer. The yearly layer carries one extra star, Nianjie.

Signature

func GetHoroscopeStar(stemKey, branchKey, scope string, language Language) ([][]Star, error)

Parameters

Return value A slice of twelve, indexed by palace index.

Star names per layer

The keys take the form yunlu (decadal Lucun), liulu (yearly), yuelu (monthly), rilu (daily), shilu (hourly).

Example

decadal, _ := iztro.GetHoroscopeStar(iztro.StemJia, iztro.BranchZi, iztro.ScopeDecadal, iztro.LanguageEnUS)

for i := 0; i < 4; i++ {
    names := []string{}
    for _, s := range decadal[i] {
        names = append(names, s.Name)
    }
    fmt.Println(i, names)
}

Output

0 [money(D) horse(D)]
1 [driven(D) attractive(D)]
2 []
3 [scholar(D)]

Edge cases and pitfalls

Low-level placement

The functions above all start from birth data, deriving the year pillar, the Soul palace and the corrected lunar month internally before placing anything. This group takes those intermediates directly and is reusable in a pipeline of your own.

Example

chart, _ := iztro.BySolar("2000-8-16", 2, iztro.GenderFemale, true, iztro.LanguageEnUS, nil)
yearBranch := chart.RawDates.ChineseDate.YearlyKeys[1]

hl, _ := iztro.GetHuoLingIndex(yearBranch, 2)
gg, _ := iztro.GetGuGuaIndex(yearBranch)
cq, _ := iztro.GetChangQuIndexByHeavenlyStem(iztro.StemJia)

fmt.Println(hl, gg, cq)

Output

{2 10} {3 11} {3 7}

Edge cases and pitfalls