Fix type predicates/docstrings for two music properties.
[lilypond/mpolesky.git] / lily / include / scale.hh
blob760e91b5b8070fd35d5305af06d784adbe379b06
1 /*
2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2006--2010 Han-Wen Nienhuys <hanwen@lilypond.org>
6 LilyPond is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 LilyPond is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
20 #ifndef SCALE_HH
21 #define SCALE_HH
23 #include "smobs.hh"
24 #include "rational.hh"
25 #include "std-vector.hh"
27 struct Scale
29 public:
30 Scale (vector<Rational> const&);
31 Scale (Scale const&);
33 Rational tones_at_step (int step, int octave) const;
34 Rational step_size (int step) const;
35 int step_count () const;
36 int normalize_step (int step) const;
38 DECLARE_SMOBS (Scale);
40 private:
41 vector<Rational> step_tones_;
44 extern Scale *default_global_scale;
46 #endif /* SCALE_HH */